com.centrasite.jaxr.type
Interface CentraSiteTypeDescription

All Known Subinterfaces:
CentraSiteBaseTypeDescription, CentraSiteVirtualTypeDescription

public interface CentraSiteTypeDescription

Description of a user defined object type.


Method Summary
 void addClassification(javax.xml.registry.infomodel.Concept concept)
          Classify this type with the given concept.
 void addClassification(java.lang.String id)
          Classify this type with the concept with the given id.
 void addClassificationAtribute(CentraSiteClassificationAttribute ca)
          Add a classification attribute to this type.
 void addClassificationAtributes(java.util.Collection<CentraSiteClassificationAttribute> cas)
          Add a collection of classification attributes to this type.
 void addComputedAttribute(CentraSiteComputedAttribute cca)
          Add a computed attribute to this type.
 void addComputedAttributes(java.util.Collection<CentraSiteComputedAttribute> ccas)
          Add a collection of computed attributes to this type.
 void addFileAtribute(CentraSiteFileAttribute fa)
          Add a file attribute to this type.
 void addFileAtributes(java.util.Collection<CentraSiteFileAttribute> fas)
          Add a collection of file attributes to this type.
 void addOperationDescription(CentraSiteOperationDescription operation)
          Deprecated.  
 void addProfile(javax.xml.registry.infomodel.RegistryEntry profile)
          Add the given profile to this type.
 void addProfiles(java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> profiles)
          Add the given profiles to this type.
 void addRelationShipAtribute(CentraSiteRelationShipAttribute ra)
          Add a relationship attribute to this type.
 void addRelationShipAtributes(java.util.Collection<CentraSiteRelationShipAttribute> ras)
          Add a collection of relationship attributes to this type.
 void addSlotDescription(CentraSiteSlotDescription slot)
          Add specified slot description.
 void addSlotDescriptions(java.util.Collection slots)
          Add a collection of slot descriptions.
 void addTriggerDescription(CentraSiteTriggerDescription trigger)
          Deprecated.  
 boolean areSlotsCreated()
          Are slots for schemaName and doctypeName already created?
 void checkValidLocalName(java.lang.String value)
          Check string whether a valid local name for a type definition
 void checkValidNameSpace(java.lang.String value)
          Check string whether a valid local name for a type definition
 void clearOperations()
          Deprecated.  
 void clearSlots()
          Clear collection of slots (GUI).
 void clearTriggers()
          Deprecated.  
 void delete(RepositoryConnector repCon)
          Delete a type description from registry/repository.
 java.util.Collection<CentraSiteTypeDescription> getAggregatedUsingTargetTypes()
          Get all types that have a Relationship attribute with RelationshipType as Composition using Target referencing this type.
 java.util.Collection<CentraSiteClassificationAttribute> getClassificationAttributes()
          Get the classification attributes.
 java.util.Collection<CentraSiteTypeDescription> getCompositedUsingTargetTypes()
          Get all types that have a Relationship attribute with RelationshipType as Composition using Target referencing this type.
 java.util.Collection<CentraSiteComputedAttribute> getComputedAttributes()
          Get the computed attributes.
 javax.xml.registry.infomodel.Concept getConcept()
          Get associated concept (GUI).
 java.lang.String getDescription()
          Get the type description.
 javax.xml.registry.infomodel.InternationalString getDisplayName()
          Get the type's display name.
 java.lang.String getDoctypeName()
          Get the link to the schema.
 java.util.Collection<CentraSiteFileAttribute> getFileAttributes()
          Get the file attributes.
 javax.xml.registry.infomodel.InternationalString getI18NDescription()
          Get the internationalized type description.
 javax.xml.registry.infomodel.ExternalLink getIconLink()
          Get the link to the type icon.
 java.util.Collection<CentraSiteJaxrAttribute> getJaxrAttributes()
          Get the JAXR attributes.
 javax.xml.registry.infomodel.ExternalLink getLargeIconLink()
          Get the link to the LargeTypeIcon.
 java.lang.String getLocalPart()
          Derive local part from complete name.
 java.lang.String getName()
          Get the type name.
 java.lang.String getNamespaceUri()
          Derive namespace from complete name.
 java.util.Collection getOperationDescriptions()
          Deprecated.  
 java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> getProfiles()
          Get the profiles.
 java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> getProfiles(java.lang.String conceptId)
          Get the profiles that are classified by the given concept
 java.util.Collection<java.lang.String> getProfileSequence()
          Get the profile sequence information.
 java.util.Collection<CentraSiteRelationShipAttribute> getRelationShipAttributes()
          Get the relationship attributes.
 java.util.Collection<CentraSiteTypeDescription> getReverselyAggregatingTypes()
          Get all types that have a Relationship attribute with ReverseAggregate option referencing this type.
 java.lang.String getSchemaName()
          Get the link to the schema.
 CentraSiteSlotDescription getSlotDescription(java.lang.String slotName)
          Get specified slot description.
 java.util.HashMap getSlotDescriptions()
          Get slot description map.
 java.util.Collection getSlotNames()
          Get slot names.
 java.util.Collection getTriggerDescriptions()
          Deprecated.  
 javax.xml.registry.infomodel.ExternalLink getXsdLink()
          Get the link to the schema.
 boolean hasOperations()
          Deprecated.  
 boolean hasTriggers()
          Deprecated.  
 boolean isBaseType()
          Return whether this type is a base type.
 boolean isClassifiedWith(javax.xml.registry.infomodel.Concept concept)
          Check whether this type is classified with the given concept.
 boolean isClassifiedWith(java.lang.String id)
          Check whether this type is classified with the concept identified by the given id.
 boolean isExtensible()
          Deprecated. types are always extensible, method always returns true
 void isExtensible(boolean extensible)
          Deprecated. types are always extensible
 boolean isVirtualType()
          Return whether this type is a virtual type.
 void lock()
          Lock the type exclusively.
 java.lang.String ncName(java.lang.String value)
          Convert the given value to an NCName.
 void removeClassification(javax.xml.registry.infomodel.Concept concept)
          Remove the classification of this type with the given concept.
 void removeClassification(java.lang.String id)
          Remove the classification of this type with the concept with the given id.
 void removeClassificationAtribute(CentraSiteClassificationAttribute ca)
          Remove a classification attribute from this type.
 void removeComputedAttribute(CentraSiteComputedAttribute cca)
          Remove a computed attribute from this type.
 void removeFileAtribute(CentraSiteFileAttribute fa)
          Remove a file attribute from this type.
 void removeOperationDescription(CentraSiteOperationDescription operation)
          Deprecated.  
 void removeProfile(javax.xml.registry.infomodel.RegistryEntry profile)
          remove the given profile from this type.
 void removeRelationShipAtribute(CentraSiteRelationShipAttribute ra)
          Remove a relationship attribute from this type.
 void removeTriggerDescription(CentraSiteTriggerDescription trigger)
          Deprecated.  
 void save(RepositoryConnector repCon)
          Save the type description to registry/repository.
 void setConcept(javax.xml.registry.infomodel.Concept concept)
          Deprecated.  
 void setDescription(java.lang.String description)
          Set the type description.
 void setDisplayName(javax.xml.registry.infomodel.InternationalString name)
          Set the type's display name.
 void setIconInputStream(java.io.InputStream iconInputStream)
          Set the input stream representing the type icon.
 void setIconLink(javax.xml.registry.infomodel.ExternalLink iconLink)
          Set the link to the type icon.
 void setIconMediaType(java.lang.String iconMediaType)
          Set the media type of the type icon.
 void setIconPath(java.lang.String serverFilePath)
          Deprecated. please use setIconPath(String clientFilePath, String serverFilePath)
 void setIconPath(java.lang.String clientFilePath, java.lang.String serverFilePath)
          Deprecated. use setIconMediaType/setIconInputStream instead
 void setLargeIconInputStream(java.io.InputStream largeIconInputStream)
          Set the input stream representing the large type icon.
 void setLargeIconLink(javax.xml.registry.infomodel.ExternalLink largeIconLink)
          Set the link to the LargeTypeIcon.
 void setLargeIconMediaType(java.lang.String largeIconMediaType)
          Set the media type of the large type icon.
 void setLocalPart(java.lang.String part)
          Set local part in complete name.
 void setName(java.lang.String name)
          Set the type name.
 void setNamespaceUri(java.lang.String namespaceUri)
          Set namespace int complete name.
 void setProfileSequence(java.util.Collection<java.lang.String> pseq)
          Set the profile sequence information.
 void setUpdateProcess(boolean updateProcess)
          When calling setConcept from the SchemaTransformer is is not possible to detect whether the concept is updated or new created, because the SchemaTransformer always deletes user defined concept an then recreate the concept.
 void setXsdLink(javax.xml.registry.infomodel.ExternalLink xsdLink)
          Set the link to the schema.
 java.lang.String toXML()
          Get XML representation (schema).
 java.lang.String toXmlForExport()
          Get XML representation for type export.
 

Method Detail

isBaseType

boolean isBaseType()
                   throws javax.xml.registry.JAXRException
Return whether this type is a base type.

Returns:
true if this type is a base type.
Throws:
javax.xml.registry.JAXRException

isVirtualType

boolean isVirtualType()
                      throws javax.xml.registry.JAXRException
Return whether this type is a virtual type.

Returns:
true if this type is a virtual type.
Throws:
javax.xml.registry.JAXRException

setName

void setName(java.lang.String name)
             throws javax.xml.registry.JAXRException
Set the type name. Check uniqueness of type name.

Parameters:
name - name of the form "{uri}local-name".
Throws:
javax.xml.registry.JAXRException

getName

java.lang.String getName()
Get the type name.

Returns:
name of the form "{uri}local-name".

setDisplayName

void setDisplayName(javax.xml.registry.infomodel.InternationalString name)
                    throws javax.xml.registry.JAXRException
Set the type's display name.

Parameters:
name - name
Throws:
javax.xml.registry.JAXRException

getDisplayName

javax.xml.registry.infomodel.InternationalString getDisplayName()
Get the type's display name.

Returns:
type's display name - defaults to Concept name as obtained by getName().

setNamespaceUri

void setNamespaceUri(java.lang.String namespaceUri)
Set namespace int complete name.

Parameters:
namespaceUri - namespace URI

getNamespaceUri

java.lang.String getNamespaceUri()
Derive namespace from complete name.

Returns:
namespace

setLocalPart

void setLocalPart(java.lang.String part)
Set local part in complete name.

Parameters:
part - local part

getLocalPart

java.lang.String getLocalPart()
Derive local part from complete name.

Returns:
local part

setConcept

void setConcept(javax.xml.registry.infomodel.Concept concept)
                throws javax.xml.registry.JAXRException
Deprecated. 

Set associated concept (GUI).

Parameters:
concept - associated concept
Throws:
javax.xml.registry.JAXRException

getConcept

javax.xml.registry.infomodel.Concept getConcept()
                                                throws javax.xml.registry.JAXRException
Get associated concept (GUI).

Returns:
associated concept
Throws:
javax.xml.registry.JAXRException

setDescription

void setDescription(java.lang.String description)
Set the type description.

Parameters:
description - description of type

getDescription

java.lang.String getDescription()
Get the type description.

Returns:
description of type

getI18NDescription

javax.xml.registry.infomodel.InternationalString getI18NDescription()
                                                                    throws javax.xml.registry.JAXRException
Get the internationalized type description.

Returns:
internationalized description of type. Maybe null if description not yet known.
Throws:
javax.xml.registry.JAXRException

isExtensible

void isExtensible(boolean extensible)
Deprecated. types are always extensible

Are arbitrary slots allowed?

Parameters:
extensible - true if arbitrary slots allowed, false otherwise

isExtensible

boolean isExtensible()
Deprecated. types are always extensible, method always returns true

Are arbitrary slots allowed?

Returns:
true if arbitrary slots allowed, false otherwise

areSlotsCreated

boolean areSlotsCreated()
Are slots for schemaName and doctypeName already created?

Returns:
true if arbitrary slots allowed, false otherwise

setUpdateProcess

void setUpdateProcess(boolean updateProcess)
When calling setConcept from the SchemaTransformer is is not possible to detect whether the concept is updated or new created, because the SchemaTransformer always deletes user defined concept an then recreate the concept. This means that the method isNew() for the concept always returns true. To verify that an update is running the SchemaTransformer calls this function before doing setConcept()


getSlotNames

java.util.Collection getSlotNames()
Get slot names.

Returns:
collection of slot names (String or QName?)

addSlotDescription

void addSlotDescription(CentraSiteSlotDescription slot)
Add specified slot description.

Parameters:
slot - slot to add

addSlotDescriptions

void addSlotDescriptions(java.util.Collection slots)
                         throws javax.xml.registry.JAXRException
Add a collection of slot descriptions.

Parameters:
slots - collection of slot descriptions to add
Throws:
javax.xml.registry.JAXRException

getSlotDescription

CentraSiteSlotDescription getSlotDescription(java.lang.String slotName)
Get specified slot description.

Parameters:
slotName - slot name to get description for
Returns:
slot description or null if not found

getSlotDescriptions

java.util.HashMap getSlotDescriptions()
Get slot description map.

Returns:
slot description map

clearSlots

void clearSlots()
Clear collection of slots (GUI).


getClassificationAttributes

java.util.Collection<CentraSiteClassificationAttribute> getClassificationAttributes()
                                                                                    throws javax.xml.registry.JAXRException
Get the classification attributes.

Returns:
a collection of classification attributes. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

addClassificationAtribute

void addClassificationAtribute(CentraSiteClassificationAttribute ca)
                               throws javax.xml.registry.JAXRException
Add a classification attribute to this type.

Parameters:
ca - the classification attribute
Throws:
javax.xml.registry.JAXRException

addClassificationAtributes

void addClassificationAtributes(java.util.Collection<CentraSiteClassificationAttribute> cas)
                                throws javax.xml.registry.JAXRException
Add a collection of classification attributes to this type.

Parameters:
cas - the collection of classification attributes
Throws:
javax.xml.registry.JAXRException

removeClassificationAtribute

void removeClassificationAtribute(CentraSiteClassificationAttribute ca)
                                  throws javax.xml.registry.JAXRException
Remove a classification attribute from this type.

Parameters:
ca - the classification attribute
Throws:
javax.xml.registry.JAXRException

getFileAttributes

java.util.Collection<CentraSiteFileAttribute> getFileAttributes()
                                                                throws javax.xml.registry.JAXRException
Get the file attributes.

Returns:
a collection of file attributes. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

addFileAtribute

void addFileAtribute(CentraSiteFileAttribute fa)
                     throws javax.xml.registry.JAXRException
Add a file attribute to this type.

Parameters:
fa - the file attribute
Throws:
javax.xml.registry.JAXRException

addFileAtributes

void addFileAtributes(java.util.Collection<CentraSiteFileAttribute> fas)
                      throws javax.xml.registry.JAXRException
Add a collection of file attributes to this type.

Parameters:
fas - the collection of file attributes
Throws:
javax.xml.registry.JAXRException

removeFileAtribute

void removeFileAtribute(CentraSiteFileAttribute fa)
                        throws javax.xml.registry.JAXRException
Remove a file attribute from this type.

Parameters:
fa - the file attribute
Throws:
javax.xml.registry.JAXRException

getComputedAttributes

java.util.Collection<CentraSiteComputedAttribute> getComputedAttributes()
                                                                        throws javax.xml.registry.JAXRException
Get the computed attributes.

Returns:
a collection of computed attributes. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

addComputedAttribute

void addComputedAttribute(CentraSiteComputedAttribute cca)
                          throws javax.xml.registry.JAXRException
Add a computed attribute to this type.

Parameters:
cca - the computed attribute
Throws:
javax.xml.registry.JAXRException

addComputedAttributes

void addComputedAttributes(java.util.Collection<CentraSiteComputedAttribute> ccas)
                           throws javax.xml.registry.JAXRException
Add a collection of computed attributes to this type.

Parameters:
ccas - the collection of computed attributes
Throws:
javax.xml.registry.JAXRException

removeComputedAttribute

void removeComputedAttribute(CentraSiteComputedAttribute cca)
                             throws javax.xml.registry.JAXRException
Remove a computed attribute from this type.

Parameters:
cca - the computed attribute
Throws:
javax.xml.registry.JAXRException

getRelationShipAttributes

java.util.Collection<CentraSiteRelationShipAttribute> getRelationShipAttributes()
                                                                                throws javax.xml.registry.JAXRException
Get the relationship attributes.

Returns:
a collection of relationship attributes. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

addRelationShipAtribute

void addRelationShipAtribute(CentraSiteRelationShipAttribute ra)
                             throws javax.xml.registry.JAXRException
Add a relationship attribute to this type.

Parameters:
ra - the relationship attribute
Throws:
javax.xml.registry.JAXRException

addRelationShipAtributes

void addRelationShipAtributes(java.util.Collection<CentraSiteRelationShipAttribute> ras)
                              throws javax.xml.registry.JAXRException
Add a collection of relationship attributes to this type.

Parameters:
ras - the collection of relationship attributes
Throws:
javax.xml.registry.JAXRException

removeRelationShipAtribute

void removeRelationShipAtribute(CentraSiteRelationShipAttribute ra)
                                throws javax.xml.registry.JAXRException
Remove a relationship attribute from this type.

Parameters:
ra - the relationship attribute
Throws:
javax.xml.registry.JAXRException

getJaxrAttributes

java.util.Collection<CentraSiteJaxrAttribute> getJaxrAttributes()
                                                                throws javax.xml.registry.JAXRException
Get the JAXR attributes.

Returns:
a collection of JAXR attributes. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

getProfiles

java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> getProfiles()
                                                                             throws javax.xml.registry.JAXRException
Get the profiles.

Returns:
a collection of profile RegistryEntries. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

getProfiles

java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> getProfiles(java.lang.String conceptId)
                                                                             throws javax.xml.registry.JAXRException
Get the profiles that are classified by the given concept

Returns:
a collection of profile RegistryEntries. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

addProfiles

void addProfiles(java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> profiles)
                 throws javax.xml.registry.JAXRException
Add the given profiles to this type.

Parameters:
profiles - collection of profile instances
Throws:
javax.xml.registry.JAXRException

addProfile

void addProfile(javax.xml.registry.infomodel.RegistryEntry profile)
                throws javax.xml.registry.JAXRException
Add the given profile to this type.

Parameters:
profile - the profile to be added
Throws:
javax.xml.registry.JAXRException

removeProfile

void removeProfile(javax.xml.registry.infomodel.RegistryEntry profile)
                   throws javax.xml.registry.JAXRException
remove the given profile from this type.

Parameters:
profile - the profile to be removed
Throws:
javax.xml.registry.JAXRException

getProfileSequence

java.util.Collection<java.lang.String> getProfileSequence()
                                                          throws javax.xml.registry.JAXRException
Get the profile sequence information. If this is empty, then the profile sequence is defined by the order returned by getProfiles().

Returns:
a collection of profile ids. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

setProfileSequence

void setProfileSequence(java.util.Collection<java.lang.String> pseq)
                        throws javax.xml.registry.JAXRException
Set the profile sequence information.

Parameters:
pseq - the collection of profile ids
Throws:
javax.xml.registry.JAXRException

isClassifiedWith

boolean isClassifiedWith(javax.xml.registry.infomodel.Concept concept)
                         throws javax.xml.registry.JAXRException
Check whether this type is classified with the given concept.

Parameters:
concept - the classification concept
Returns:
true if this type is classified with the given concept
Throws:
javax.xml.registry.JAXRException

isClassifiedWith

boolean isClassifiedWith(java.lang.String id)
                         throws javax.xml.registry.JAXRException
Check whether this type is classified with the concept identified by the given id.

Parameters:
id - the classification concept id
Returns:
true if this type is classified with the given concept
Throws:
javax.xml.registry.JAXRException

addClassification

void addClassification(javax.xml.registry.infomodel.Concept concept)
                       throws javax.xml.registry.JAXRException
Classify this type with the given concept. The concept has to belong to the "CentraSiteTypes" taxonomy.

Parameters:
concept - the concept to be used for classification
Throws:
javax.xml.registry.JAXRException

addClassification

void addClassification(java.lang.String id)
                       throws javax.xml.registry.JAXRException
Classify this type with the concept with the given id. The concept has to belong to the "CentraSiteTypes" taxonomy.

Parameters:
id - the id of the concept to be used for classification
Throws:
javax.xml.registry.JAXRException

removeClassification

void removeClassification(javax.xml.registry.infomodel.Concept concept)
                          throws javax.xml.registry.JAXRException
Remove the classification of this type with the given concept.

Parameters:
concept - the concept to be removed
Throws:
javax.xml.registry.JAXRException

removeClassification

void removeClassification(java.lang.String id)
                          throws javax.xml.registry.JAXRException
Remove the classification of this type with the concept with the given id.

Parameters:
id - the id of the concept to be removed
Throws:
javax.xml.registry.JAXRException

clearOperations

void clearOperations()
Deprecated. 

Clear collection of operations (GUI).


hasOperations

boolean hasOperations()
Deprecated. 

Has the type got any operations?

Returns:
true if there is at least one operation, false otherwise

addOperationDescription

void addOperationDescription(CentraSiteOperationDescription operation)
Deprecated. 

Add operation description to type.

Parameters:
operation - operation to add

getOperationDescriptions

java.util.Collection getOperationDescriptions()
Deprecated. 

Get all operation descriptions for this type.

Returns:
collection of CentraSiteOperationDescription (may be empty but not null)

removeOperationDescription

void removeOperationDescription(CentraSiteOperationDescription operation)
Deprecated. 

Remove operation description from type.

Parameters:
operation - operation to remove

clearTriggers

void clearTriggers()
Deprecated. 

Clear collection of triggers (GUI).


hasTriggers

boolean hasTriggers()
Deprecated. 

Has the type got any root level triggers?

Returns:
true if there is at least one trigger, false otherwise

addTriggerDescription

void addTriggerDescription(CentraSiteTriggerDescription trigger)
Deprecated. 

Add trigger description to type.

Parameters:
trigger - trigger to add

getTriggerDescriptions

java.util.Collection getTriggerDescriptions()
Deprecated. 

Get all trigger descriptions for this type defined for root node.

Returns:
collection of CentraSiteTriggerDescription (may be empty but not null)

removeTriggerDescription

void removeTriggerDescription(CentraSiteTriggerDescription trigger)
Deprecated. 

Remove trigger description from type.

Parameters:
trigger - trigger to remove

setIconPath

void setIconPath(java.lang.String clientFilePath,
                 java.lang.String serverFilePath)
                 throws java.lang.Exception
Deprecated. use setIconMediaType/setIconInputStream instead

Set path to icon (GUI).

Parameters:
clientFilePath - real path to icon
serverFilePath - temporary path to icon
Throws:
java.lang.Exception

setIconPath

void setIconPath(java.lang.String serverFilePath)
                 throws java.lang.Exception
Deprecated. please use setIconPath(String clientFilePath, String serverFilePath)

Set path to icon.

Parameters:
serverFilePath - temporary path to icon
Throws:
java.lang.Exception

setIconMediaType

void setIconMediaType(java.lang.String iconMediaType)
Set the media type of the type icon.

Parameters:
iconMediaType - the media type of the type icon.

setIconInputStream

void setIconInputStream(java.io.InputStream iconInputStream)
                        throws java.io.IOException
Set the input stream representing the type icon.

Parameters:
iconInputStream - the input stream representing the type icon.
Throws:
java.io.IOException

setLargeIconMediaType

void setLargeIconMediaType(java.lang.String largeIconMediaType)
Set the media type of the large type icon.

Parameters:
largeIconMediaType - the media type of the large type icon.

setLargeIconInputStream

void setLargeIconInputStream(java.io.InputStream largeIconInputStream)
                             throws java.io.IOException
Set the input stream representing the large type icon.

Parameters:
largeIconInputStream - the input stream representing the large type icon.
Throws:
java.io.IOException

setIconLink

void setIconLink(javax.xml.registry.infomodel.ExternalLink iconLink)
Set the link to the type icon.

Parameters:
iconLink - link to type icon

getIconLink

javax.xml.registry.infomodel.ExternalLink getIconLink()
                                                      throws javax.xml.registry.JAXRException
Get the link to the type icon.

Returns:
link to type icon
Throws:
javax.xml.registry.JAXRException

setLargeIconLink

void setLargeIconLink(javax.xml.registry.infomodel.ExternalLink largeIconLink)
Set the link to the LargeTypeIcon.

Parameters:
largeIconLink - link to LargeTypeIcon

getLargeIconLink

javax.xml.registry.infomodel.ExternalLink getLargeIconLink()
                                                           throws javax.xml.registry.JAXRException
Get the link to the LargeTypeIcon.

Returns:
link to LargeTypeIcon
Throws:
javax.xml.registry.JAXRException

setXsdLink

void setXsdLink(javax.xml.registry.infomodel.ExternalLink xsdLink)
Set the link to the schema.

Parameters:
xsdLink - link to schema

getXsdLink

javax.xml.registry.infomodel.ExternalLink getXsdLink()
                                                     throws javax.xml.registry.JAXRException
Get the link to the schema.

Returns:
link to schema
Throws:
javax.xml.registry.JAXRException

getSchemaName

java.lang.String getSchemaName()
                               throws javax.xml.registry.JAXRException
Get the link to the schema.

Returns:
link to schema
Throws:
javax.xml.registry.JAXRException

getDoctypeName

java.lang.String getDoctypeName()
                                throws javax.xml.registry.JAXRException
Get the link to the schema.

Returns:
link to schema
Throws:
javax.xml.registry.JAXRException

toXML

java.lang.String toXML()
                       throws javax.xml.registry.JAXRException
Get XML representation (schema).

Returns:
XML representation (schema)
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs

toXmlForExport

java.lang.String toXmlForExport()
                                throws javax.xml.registry.JAXRException
Get XML representation for type export.

Returns:
XML representation
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs

checkValidLocalName

void checkValidLocalName(java.lang.String value)
                         throws java.lang.Exception
Check string whether a valid local name for a type definition

Parameters:
value - the string to be checked
Throws:
java.lang.Exception

checkValidNameSpace

void checkValidNameSpace(java.lang.String value)
                         throws java.lang.Exception
Check string whether a valid local name for a type definition

Parameters:
value - the string to be checked
Throws:
java.lang.Exception

save

void save(RepositoryConnector repCon)
          throws java.lang.Exception
Save the type description to registry/repository.

Parameters:
repCon - repository connector
Throws:
java.lang.Exception - in case of any storage/retrieval failure

delete

void delete(RepositoryConnector repCon)
            throws java.lang.Exception
Delete a type description from registry/repository.

Parameters:
repCon - repository connector
Throws:
java.lang.Exception - in case of any storage/retrieval failure

lock

void lock()
          throws javax.xml.registry.JAXRException
Lock the type exclusively. Upon successful return the lock is granted. If the lock cannot be granted, a LockNotAvailableException will be thrown. The lock will be released when save() is called. In order to release the lock without saving the type call rollback().

Throws:
JAXRException, - LockNotAvailableException
javax.xml.registry.JAXRException

ncName

java.lang.String ncName(java.lang.String value)
                        throws javax.xml.registry.JAXRException
Convert the given value to an NCName. If any, replace the offending characters by '_'. If the input value is the empty string return "_".

Parameters:
value - the value to be converted to NCName
Returns:
the input value, with any offending characters replaced by '_'
Throws:
javax.xml.registry.JAXRException

getReverselyAggregatingTypes

java.util.Collection<CentraSiteTypeDescription> getReverselyAggregatingTypes()
                                                                             throws javax.xml.registry.JAXRException
Get all types that have a Relationship attribute with ReverseAggregate option referencing this type.

Returns:
the collection of all reversely aggregating types.
Throws:
javax.xml.registry.JAXRException

getCompositedUsingTargetTypes

java.util.Collection<CentraSiteTypeDescription> getCompositedUsingTargetTypes()
                                                                              throws javax.xml.registry.JAXRException
Get all types that have a Relationship attribute with RelationshipType as Composition using Target referencing this type.

Returns:
the collection of all reversely composite types.
Throws:
javax.xml.registry.JAXRException

getAggregatedUsingTargetTypes

java.util.Collection<CentraSiteTypeDescription> getAggregatedUsingTargetTypes()
                                                                              throws javax.xml.registry.JAXRException
Get all types that have a Relationship attribute with RelationshipType as Composition using Target referencing this type.

Returns:
the collection of all reversely aggregated types.
Throws:
javax.xml.registry.JAXRException