public interface CentraSiteTypeDescription
Modifier and Type | Method and Description |
---|---|
void |
addClassification(Concept concept)
Classifies this type with the given concept.
|
void |
addClassificationAtribute(CentraSiteClassificationAttribute ca)
Adds a classification attribute to this type.
|
void |
addClassificationAtributes(java.util.Collection<CentraSiteClassificationAttribute> cas)
Adds a collection of classification attributes to this type.
|
void |
addComputedAttribute(CentraSiteComputedAttribute cca)
Adds a computed attribute to this type.
|
void |
addComputedAttributes(java.util.Collection<CentraSiteComputedAttribute> ccas)
Adds a collection of computed attributes to this type.
|
void |
addConsumableTypes(java.util.Collection<CentraSiteTypeDescription> consumableTypes)
Adds collection of consumable types for the type; the instance of the type can consume only those instances of types from consumable types list.
|
void |
addFileAtribute(CentraSiteFileAttribute fa)
Adds a file attribute to this type.
|
void |
addFileAtributes(java.util.Collection<CentraSiteFileAttribute> fas)
Adds a collection of file attributes to this type.
|
void |
addOperationDescription(CentraSiteOperationDescription operation)
Deprecated.
|
void |
addProfile(RegistryEntry profile)
Adds the given profile to this type.
|
void |
addProfiles(java.util.Collection<RegistryEntry> profiles)
Adds the given profiles to this type.
|
void |
addRelationShipAtribute(CentraSiteRelationShipAttribute ra)
Adds a relationship attribute to this type.
|
void |
addRelationShipAtributes(java.util.Collection<CentraSiteRelationShipAttribute> ras)
Adds a collection of relationship attributes to this type.
|
void |
addSlotDescription(CentraSiteSlotDescription slot)
Adds specified slot description.
|
void |
addSlotDescriptions(java.util.Collection slots)
Adds a collection of slot descriptions.
|
void |
addTriggerDescription(CentraSiteTriggerDescription trigger)
Deprecated.
|
boolean |
areSlotsCreated()
Returns whether slots for schemaName and doctypeName are already created or not.
|
boolean |
canRemoveConsumableType(CentraSiteTypeDescription consumableType)
Checks whether the given asset type is allowed to be removed from the consumable types defined for this type.
|
void |
checkValidLocalName(java.lang.String value)
Checks string whether a valid local name for a type definition.
|
void |
checkValidNameSpace(java.lang.String value)
Checks string whether a valid local name for a type definition.
|
void |
clearOperations()
Deprecated.
|
void |
clearSlots()
Clears collection of slots (GUI).
|
void |
clearTriggers()
Deprecated.
|
void |
delete(RepositoryConnector repCon)
Deletes a type description from registry/repository.
|
java.util.Collection<CentraSiteTypeDescription> |
getAggregatedUsingTargetTypes()
Gets 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()
Gets all types that have a Relationship attribute with RelationshipType as Composition using Target
referencing this type.
|
java.util.Collection<CentraSiteComputedAttribute> |
getComputedAttributes()
Gets the computed attributes.
|
Concept |
getConcept()
Gets associated concept (GUI).
|
java.util.Collection<CentraSiteTypeDescription> |
getConsumableTypes()
Gets all consumable types defined for the type.
|
java.lang.String |
getConsumerRegistrationKey()
Gets the consumer registration (definition of consumable types of the type) key
|
java.lang.String |
getDescription()
Gets the type description.
|
InternationalString |
getDisplayName()
Gets the type's display name.
|
java.lang.String |
getDoctypeName()
Gets the link to the Document type name.
|
java.util.Collection<CentraSiteFileAttribute> |
getFileAttributes()
Gets the file attributes.
|
InternationalString |
getI18NDescription()
Gets the internationalized type description.
|
ExternalLink |
getIconLink()
Gets the link to the type icon.
|
java.util.Collection<CentraSiteJaxrAttribute> |
getJaxrAttributes()
Gets the JAXR attributes.
|
ExternalLink |
getLargeIconLink()
Gets the link to the LargeTypeIcon.
|
java.lang.String |
getLocalPart()
Derives local part from complete name.
|
java.lang.String |
getName()
Gets the type name.
|
java.lang.String |
getNamespaceUri()
Derives namespace from complete name.
|
java.util.Collection |
getOperationDescriptions()
Deprecated.
|
java.util.Collection<RegistryEntry> |
getProfiles()
Gets the profiles.
|
java.util.Collection<RegistryEntry> |
getProfiles(java.lang.String conceptId)
Gets the profiles that are classified by the given concept.
|
java.util.Collection<java.lang.String> |
getProfileSequence()
Gets the profile sequence information.
|
java.util.Collection<CentraSiteRelationShipAttribute> |
getRelationShipAttributes()
Gets the relationship attributes.
|
java.util.Collection<CentraSiteTypeDescription> |
getReverselyAggregatingTypes()
Gets all types that have a Relationship attribute with ReverseAggregate option
referencing this type.
|
java.lang.String |
getSchemaName()
Gets the link to the schema.
|
CentraSiteSlotDescription |
getSlotDescription(java.lang.String slotName)
Gets specified slot description.
|
java.util.HashMap |
getSlotDescriptions()
Gets slot description map.
|
java.util.Collection |
getSlotNames()
Gets the slot names.
|
java.util.Collection |
getTriggerDescriptions()
Deprecated.
|
ExternalLink |
getXsdLink()
Gets the link to the schema.
|
boolean |
hasOperations()
Deprecated.
|
boolean |
hasTriggers()
Deprecated.
|
boolean |
isBaseType()
Returns whether this type is a base type.
|
boolean |
isClassifiedWith(Concept concept)
Checks whether this type is classified with the given concept.
|
boolean |
isExtensible()
Deprecated.
types are always extensible, method always returns true
|
void |
isExtensible(boolean extensible)
Deprecated.
types are always extensible
|
boolean |
isVirtualType()
Returns whether this type is a virtual type.
|
void |
lock()
Locks the type exclusively.
|
java.lang.String |
ncName(java.lang.String value)
Converts the given value to an NCName.
|
void |
removeClassification(Concept concept)
Removes the classification of this type with the given concept.
|
void |
removeClassificationAtribute(CentraSiteClassificationAttribute ca)
Removes a classification attribute from this type.
|
void |
removeComputedAttribute(CentraSiteComputedAttribute cca)
Removes a computed attribute from this type.
|
void |
removeConsumableTypes(java.util.Collection<CentraSiteTypeDescription> consumableTypes)
Removes collection of consumable types from the type.
|
void |
removeFileAtribute(CentraSiteFileAttribute fa)
Removes a file attribute from this type.
|
void |
removeOperationDescription(CentraSiteOperationDescription operation)
Deprecated.
|
void |
removeProfile(RegistryEntry profile)
Removes the given profile from this type.
|
void |
removeRelationShipAtribute(CentraSiteRelationShipAttribute ra)
Removes a relationship attribute from this type.
|
void |
removeSlot(CentraSiteSlotDescription slot)
Clear collection of slots (GUI).
|
void |
removeTriggerDescription(CentraSiteTriggerDescription trigger)
Deprecated.
|
void |
save(RepositoryConnector repCon)
Saves the type description to registry/repository.
|
void |
setConcept(Concept concept)
Sets associated concept (GUI).
|
void |
setConsumableTypes(java.util.Collection<CentraSiteTypeDescription> consumableTypes)
Sets the given collection of consumable types as the finer set of consumable type of the asset type.
|
void |
setDescription(java.lang.String description)
Sets the type description.
|
void |
setDisplayName(InternationalString name)
Sets the type's display name.
|
void |
setIconInputStream(java.io.InputStream iconInputStream)
Sets the input stream representing the type icon.
|
void |
setIconLink(ExternalLink iconLink)
Sets the link to the type icon.
|
void |
setIconMediaType(java.lang.String iconMediaType)
Sets 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)
Sets the input stream representing the large type icon.
|
void |
setLargeIconLink(ExternalLink largeIconLink)
Sets the link to the LargeTypeIcon.
|
void |
setLargeIconMediaType(java.lang.String largeIconMediaType)
Sets the media type of the large type icon.
|
void |
setLocalPart(java.lang.String part)
Sets local part in complete name.
|
void |
setName(java.lang.String name)
Sets the type name.
|
void |
setNamespaceUri(java.lang.String namespaceUri)
Sets namespace int complete name.
|
void |
setProfileSequence(java.util.Collection<java.lang.String> pseq)
Sets 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(ExternalLink xsdLink)
Sets the link to the schema.
|
java.lang.String |
toXML()
Gets XML representation (schema).
|
java.lang.String |
toXmlForExport()
Gets XML representation for type export.
|
boolean isBaseType() throws JAXRException
JAXRException
- if an internal error occurs.boolean isVirtualType() throws JAXRException
JAXRException
- if an internal error occurs.void setName(java.lang.String name) throws JAXRException
name
- name of the form "{uri}local-name".JAXRException
- if an internal error occurs on setting the type name.java.lang.String getName()
void setDisplayName(InternationalString name) throws JAXRException
name
- the display name as InternationalString
.JAXRException
- if an internal error occurs.InternationalString getDisplayName()
void setNamespaceUri(java.lang.String namespaceUri)
namespaceUri
- namespace URIjava.lang.String getNamespaceUri()
void setLocalPart(java.lang.String part)
part
- local partjava.lang.String getLocalPart()
void setConcept(Concept concept) throws JAXRException
concept
- associated conceptJAXRException
- if encounters an internal error on setting the concept object.Concept getConcept() throws JAXRException
JAXRException
- if encounters an internal error on getting the concept object.void setDescription(java.lang.String description)
description
- description of typejava.lang.String getDescription()
InternationalString getI18NDescription() throws JAXRException
JAXRException
- if encounters an internal error.void isExtensible(boolean extensible)
extensible
- true if arbitrary slots allowed, false otherwiseboolean isExtensible()
boolean areSlotsCreated()
void setUpdateProcess(boolean updateProcess)
updateProcess
- the boolean value to update the process.java.util.Collection getSlotNames()
void addSlotDescription(CentraSiteSlotDescription slot)
slot
- slot to addvoid addSlotDescriptions(java.util.Collection slots) throws JAXRException
slots
- collection of slot descriptions to add.JAXRException
- if encounters an internal error.CentraSiteSlotDescription getSlotDescription(java.lang.String slotName)
slotName
- slot name to get description forjava.util.HashMap getSlotDescriptions()
void clearSlots()
void removeSlot(CentraSiteSlotDescription slot) throws JAXRException
slot
- slot to remove.JAXRException
- if an internal error on removing the slot.java.util.Collection<CentraSiteClassificationAttribute> getClassificationAttributes() throws JAXRException
JAXRException
- if encounters an internal error on getting the classification attributes.void addClassificationAtribute(CentraSiteClassificationAttribute ca) throws JAXRException
ca
- the classification attributeJAXRException
- if encounters an internal error on adding the classification attribute.void addClassificationAtributes(java.util.Collection<CentraSiteClassificationAttribute> cas) throws JAXRException
cas
- the collection of classification attributesJAXRException
- if encounters an internal error on adding the classification attributes.void removeClassificationAtribute(CentraSiteClassificationAttribute ca) throws JAXRException
ca
- the classification attributeJAXRException
- if encounters an internal error on removing the classification attribute.java.util.Collection<CentraSiteFileAttribute> getFileAttributes() throws JAXRException
JAXRException
- if encounters an internal error on getting the file attributes.void addFileAtribute(CentraSiteFileAttribute fa) throws JAXRException
fa
- the file attributeJAXRException
- if encounters an internal error on adding the file attribute.void addFileAtributes(java.util.Collection<CentraSiteFileAttribute> fas) throws JAXRException
fas
- the collection of file attributesJAXRException
- if encounters an internal error on adding the file attributes.void removeFileAtribute(CentraSiteFileAttribute fa) throws JAXRException
fa
- the file attributeJAXRException
- if encounters an internal error on removing the file attribute.java.util.Collection<CentraSiteComputedAttribute> getComputedAttributes() throws JAXRException
JAXRException
- if encounters an internal error on getting the computed attributes.void addComputedAttribute(CentraSiteComputedAttribute cca) throws JAXRException
cca
- the computed attributeJAXRException
- if encounters an internal error on adding the computed attribute.void addComputedAttributes(java.util.Collection<CentraSiteComputedAttribute> ccas) throws JAXRException
ccas
- the collection of computed attributesJAXRException
- if encounters an internal error on getting the computed attributes.void removeComputedAttribute(CentraSiteComputedAttribute cca) throws JAXRException
cca
- the computed attributeJAXRException
- if encounters an internal error on removing the computed attributes.java.util.Collection<CentraSiteRelationShipAttribute> getRelationShipAttributes() throws JAXRException
JAXRException
- if encounters an internal error on getting the relationship attributes.void addRelationShipAtribute(CentraSiteRelationShipAttribute ra) throws JAXRException
ra
- the relationship attributeJAXRException
- if encounters an internal error on adding the relationship attribute.void addRelationShipAtributes(java.util.Collection<CentraSiteRelationShipAttribute> ras) throws JAXRException
ras
- the collection of relationship attributesJAXRException
- if encounters an internal error on adding the relationship attributes.void removeRelationShipAtribute(CentraSiteRelationShipAttribute ra) throws JAXRException
ra
- the relationship attributeJAXRException
- if encounters an internal error on removing the relationship attribute.java.util.Collection<CentraSiteJaxrAttribute> getJaxrAttributes() throws JAXRException
JAXRException
- if encounters an internal error on getting the jaxr attributes.java.util.Collection<RegistryEntry> getProfiles() throws JAXRException
JAXRException
- if encounters an internal error on getting the profiles.java.util.Collection<RegistryEntry> getProfiles(java.lang.String conceptId) throws JAXRException
conceptId
- the concept ID.JAXRException
- if encounters an internal error on getting the profiles.void addProfiles(java.util.Collection<RegistryEntry> profiles) throws JAXRException
profiles
- collection of profile instancesJAXRException
- if encounters an internal error on adding the profiles.void addProfile(RegistryEntry profile) throws JAXRException
profile
- the profile to be addedJAXRException
- if encounters an internal error on adding the profile.void removeProfile(RegistryEntry profile) throws JAXRException
profile
- the profile to be removedJAXRException
- if encounters an internal error on removing the profile.java.util.Collection<java.lang.String> getProfileSequence() throws JAXRException
JAXRException
- if encounters an internal error on getting the profile sequence.void setProfileSequence(java.util.Collection<java.lang.String> pseq) throws JAXRException
pseq
- the collection of profile ID'sJAXRException
- if encounters an internal error on setting the profile sequence.boolean isClassifiedWith(Concept concept) throws JAXRException
concept
- the classification conceptJAXRException
- if encounters an internal error.void addClassification(Concept concept) throws JAXRException
concept
- the concept to be used for classificationJAXRException
- if encounters an internal error on adding the classification.void removeClassification(Concept concept) throws JAXRException
concept
- the concept to be removedJAXRException
- if encounters an internal error on removing the classification.void clearOperations()
boolean hasOperations()
void addOperationDescription(CentraSiteOperationDescription operation)
operation
- operation to addjava.util.Collection getOperationDescriptions()
void removeOperationDescription(CentraSiteOperationDescription operation)
operation
- operation to removevoid clearTriggers()
boolean hasTriggers()
void addTriggerDescription(CentraSiteTriggerDescription trigger)
trigger
- trigger to addjava.util.Collection getTriggerDescriptions()
void removeTriggerDescription(CentraSiteTriggerDescription trigger)
trigger
- trigger to removevoid setIconPath(java.lang.String clientFilePath, java.lang.String serverFilePath) throws java.lang.Exception
clientFilePath
- real path to iconserverFilePath
- temporary path to iconjava.lang.Exception
- if an internal error occurs.void setIconPath(java.lang.String serverFilePath) throws java.lang.Exception
serverFilePath
- temporary path to icon.java.lang.Exception
- if an internal error occurs.void setIconMediaType(java.lang.String iconMediaType)
iconMediaType
- the media type of the type icon.void setIconInputStream(java.io.InputStream iconInputStream) throws java.io.IOException
iconInputStream
- the input stream representing the type icon.java.io.IOException
void setLargeIconMediaType(java.lang.String largeIconMediaType)
largeIconMediaType
- the media type of the large type icon.void setLargeIconInputStream(java.io.InputStream largeIconInputStream) throws java.io.IOException
largeIconInputStream
- the input stream representing the large type icon.java.io.IOException
- if encounters an internal error.void setIconLink(ExternalLink iconLink)
iconLink
- link to type iconExternalLink getIconLink() throws JAXRException
JAXRException
- if encounters an internal error.void setLargeIconLink(ExternalLink largeIconLink)
largeIconLink
- link to LargeTypeIconExternalLink getLargeIconLink() throws JAXRException
JAXRException
- if an internal error occurs on getting the large icon link.void setXsdLink(ExternalLink xsdLink)
xsdLink
- link to schemaExternalLink getXsdLink() throws JAXRException
JAXRException
- if an internal error occurs on getting xsd link.java.lang.String getSchemaName() throws JAXRException
JAXRException
- if an internal error occurs on getting schema name.java.lang.String getDoctypeName() throws JAXRException
JAXRException
- if an internal error occurs on getting doc type name.java.lang.String toXML() throws JAXRException
JAXRException
- if a JAXR error occursjava.lang.String toXmlForExport() throws JAXRException
JAXRException
- if a JAXR error occursvoid checkValidLocalName(java.lang.String value) throws java.lang.Exception
value
- the string to be checkedjava.lang.Exception
- if an internal error occurs.void checkValidNameSpace(java.lang.String value) throws java.lang.Exception
value
- the string to be checkedjava.lang.Exception
- if an internal error occurs.void save(RepositoryConnector repCon) throws java.lang.Exception
repCon
- repository connectorjava.lang.Exception
- in case of any storage/retrieval failurevoid delete(RepositoryConnector repCon) throws java.lang.Exception
repCon
- repository connectorjava.lang.Exception
- in case of any storage/retrieval failurevoid lock() throws JAXRException
JAXRException
- if an internal error occurs.java.lang.String ncName(java.lang.String value) throws JAXRException
value
- the value to be converted to NCNameJAXRException
- if an internal error occurs.java.util.Collection<CentraSiteTypeDescription> getReverselyAggregatingTypes() throws JAXRException
JAXRException
- if an internal error occurs.java.util.Collection<CentraSiteTypeDescription> getCompositedUsingTargetTypes() throws JAXRException
JAXRException
- if an internal error.java.util.Collection<CentraSiteTypeDescription> getAggregatedUsingTargetTypes() throws JAXRException
JAXRException
- if an internal error occurs.void addConsumableTypes(java.util.Collection<CentraSiteTypeDescription> consumableTypes) throws JAXRException
consumableTypes
- Collection
of CentraSiteTypeDescription
as consumable types to be added to the type.JAXRException
- if internal error occurs while adding the given types as consumable types.void removeConsumableTypes(java.util.Collection<CentraSiteTypeDescription> consumableTypes) throws JAXRException
consumableType
- CentraSiteTypeDescription
the consumable type to be removed from the type.JAXRException
- if internal error occurs while removing the given consumable type from the type.void setConsumableTypes(java.util.Collection<CentraSiteTypeDescription> consumableTypes) throws JAXRException
consumableTypes
- Collection
of CentraSiteTypeDescription
as the consumable types of the type.JAXRException
- if internal error occurs while setting the given consumable type from the type.java.util.Collection<CentraSiteTypeDescription> getConsumableTypes() throws JAXRException
Collection
of CentraSiteTypeDescription
as the consumable types of the type.JAXRException
- if internal error occurs while fetching the consumable types of the type.java.lang.String getConsumerRegistrationKey() throws JAXRException
JAXRException
- if an internal error occurs while fetching the consumer registration key.boolean canRemoveConsumableType(CentraSiteTypeDescription consumableType) throws JAXRException
JAXRException
is thrown.
The check is performed by verifying if there are any assets of this type that has consumers which are assets
of the given type. If such an association exists, then the consumable type cannot be removed and it returns false
.
On the other hand, if no such association exists, then this method returns true
.consumableType
- The CentraSiteTypeDescription
that is already a consumable type for this typetrue
if the given type is allowed to be removed as a consumable type
and false
otherwiseJAXRException
- If the given type is not a consumable type for this type or if an error occurs while
performing the check.