org.cristalise.kernel.entity

Interface C2KLocalObject

All Known Subinterfaces:

CollectionDescription<E>

All Known Implementing Classes:

ActivityDef, AgentPath, Aggregation, AggregationDescription, AggregationInstance, Collection, CompositeActivityDef, Dependency, DependencyDescription, DomainPath, Event, History, ItemPath, Job, JobList, Outcome, OutcomeAttachment, Path, Property, RemoteMap, RolePath, Viewpoint, Workflow

public interface C2KLocalObject

Objects that are to be stored by CRISTAL-iSE Items must implement this interface and be (un)marshallable by Castor i.e. have a map file properly registered in the kernel. Domain implementors shall not create new C2KLocalObjects

See Also:

ClusterStorage, ClusterStorageManager

Method Summary

Modifier and Type	Method and Description
static void	enforceValidName(String name) Use this method to ensure very strict name policy
String	getClusterPath() Each C2KLocalObject is stored with a path identifier starting with the ClusterType: Properties: /Property/Name Workflow: /LifeCycle/workflow Collections: /Collection/Name/Version (default Name='last') Outcomes: /Outcome/SchemaName/SchemaVersion/EventID Viewpoints: /ViewPoint/SchemaName/Name (default Name='last') Events: /AuditTrail/EventID Jobs: /Job/JobID
ClusterType	getClusterType() Each object belongs to a specific type defined in ClusterType
String	getName() Gets the name of the C2KLocalObject
void	setName(String name) Sets the name of the C2KLocalObject

Method Detail

setName

void setName(String name)

Sets the name of the C2KLocalObject

Parameters:

name - Name of the C2KLocalObject

getName

String getName()

Gets the name of the C2KLocalObject

Returns:

name of the C2KLocalObject

getClusterType

ClusterType getClusterType()

Each object belongs to a specific type defined in ClusterType

Returns:

string id of the type

getClusterPath

String getClusterPath()

Each C2KLocalObject is stored with a path identifier starting with the ClusterType:

• Properties: /Property/Name
• Workflow: /LifeCycle/workflow
• Collections: /Collection/Name/Version (default Name='last')
• Outcomes: /Outcome/SchemaName/SchemaVersion/EventID
• Viewpoints: /ViewPoint/SchemaName/Name (default Name='last')
• Events: /AuditTrail/EventID
• Jobs: /Job/JobID

Returns:

The path identifier (i.e. primary key) of the object

enforceValidName

static void enforceValidName(String name)

Use this method to ensure very strict name policy

Parameters:

name - to be checked

Throws:

IllegalArgumentException - name must be alphanumeric with '_-:~' characters