Package org.cristalise.kernel.utils

Interface DescriptionObject

All Known Implementing Classes:

ActivityDef, CompositeActivityDef, DomainContext, ImportAgent, ImportItem, ImportRole, Module, PropertyDescriptionList, Query, Schema, Script, StateMachine

public interface DescriptionObject

Method Summary

Modifier and Type	Method	Description
default boolean	exists(TransactionKey transactionKey)
default void	export(Writer imports, File dir, boolean shallow)
String	getItemID()
ItemPath	getItemPath()
String	getName()
String	getNamespace()
BuiltInResources	getResourceType()
Integer	getVersion()
default String	getXml()
default String	getXml(boolean prettyPrint)
default Dependency	makeDescCollection(BuiltInCollections collection, TransactionKey transactionKey, DescriptionObject... descs)
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setItemPath(ItemPath path)
void	setName(String name)
void	setNamespace(String ns)
void	setVersion(Integer version)
default Outcome	toOutcome()

Method Details

getNamespace

String getNamespace()

getName

String getName()

getVersion

Integer getVersion()

getItemPath

ItemPath getItemPath()

setNamespace

void setNamespace(String ns)

setName

void setName(String name)

setVersion

void setVersion(Integer version)

setItemPath

void setItemPath(ItemPath path)

getItemID

String getItemID()

getResourceType

BuiltInResources getResourceType()

getXml

default String getXml(boolean prettyPrint)
               throws InvalidDataException

Throws:

InvalidDataException

getXml

default String getXml()
               throws InvalidDataException

Throws:

InvalidDataException

makeDescCollections

CollectionArrayList makeDescCollections(TransactionKey transactionKey)
                                 throws InvalidDataException,
ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

export

default void export(Writer imports,
 File dir,
 boolean shallow)
             throws InvalidDataException,
ObjectNotFoundException,
IOException

Throws:

InvalidDataException

ObjectNotFoundException

IOException

makeDescCollection

default Dependency makeDescCollection(BuiltInCollections collection,
 TransactionKey transactionKey,
 DescriptionObject... descs)
                               throws InvalidDataException

Throws:

InvalidDataException

toOutcome

default Outcome toOutcome()
                   throws CriseVertxException,
org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException,
IOException,
org.exolab.castor.mapping.MappingException

Throws:

CriseVertxException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

org.exolab.castor.mapping.MappingException

exists

default boolean exists(TransactionKey transactionKey)