org.nakedobjects.object
Interface Naked

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Aggregate, NakedCollection, NakedObject, NakedValue

All Known Implementing Classes:

AbstractNakedCollection, AbstractNakedObject, AbstractNakedValue, InternalCollection

public interface Naked

extends java.io.Serializable

Definition of an naked object. Anything that conforms to this interface can be used in an naked objects system. Objects are further broken down into two types - refernce object and value objects

An naked object must do the following

• Specify whether it is new/empty
• Specify whether it is valid
• Specify whether it should be accessed or used (About)
• Describe itself in a textual String form (using Title)
• Be able to decribe which class it is based on (getClassName/getFullClassName)

See Also:

- reference objects, - value objects

Method Summary

About	about() Returns an About object that controls the use of this object.
void	copyObject(Naked object) Copies the content of the specified object into this object.
java.lang.String	getClassName() Returns the class name without package details e.g., Transaction for the class accounts.Transaction
java.lang.String	getFullClassName() Returns the full class name including package details e.g., accounts.Transaction
java.lang.String	getObjectHelpText() Returns a textual desctiption of the object - its contents and possible uses.
boolean	isEmpty() Returns true if the object contains no data, eg when new
boolean	isSameAs(Naked object) Checks to see if two objects contain the same information.
boolean	isValid() Returns true if the object contains valid data
java.lang.String	summary() Returns a String summarising the state of the object.
Title	title() Returns a Title object describing the object.

Method Detail

about

public About about()

Returns an About object that controls the use of this object.

copyObject

public void copyObject(Naked object)

Copies the content of the specified object into this object.

getClassName

public java.lang.String getClassName()

Returns the class name without package details e.g., Transaction for the class accounts.Transaction

getFullClassName

public java.lang.String getFullClassName()

Returns the full class name including package details e.g., accounts.Transaction

getObjectHelpText

public java.lang.String getObjectHelpText()

Returns a textual desctiption of the object - its contents and possible uses.

isEmpty

public boolean isEmpty()

Returns true if the object contains no data, eg when new

isSameAs

public boolean isSameAs(Naked object)

Checks to see if two objects contain the same information. Compare with equals, which determines if the one object is replaceable with another.

Parameters:

object - the object to compare

Returns:

boolean returns true if the objects have the same content, and false if the objects are of different types or their contents are deemed to be different.

isValid

public boolean isValid()

Returns true if the object contains valid data

summary

public java.lang.String summary()

Returns a String summarising the state of the object.

title

public Title title()

Returns a Title object describing the object.