|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
boolean isBaseType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isVirtualType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setName(java.lang.String name) throws javax.xml.registry.JAXRException
name
- name of the form "{uri}local-name".
javax.xml.registry.JAXRException
java.lang.String getName()
void setDisplayName(javax.xml.registry.infomodel.InternationalString name) throws javax.xml.registry.JAXRException
name
- name
javax.xml.registry.JAXRException
javax.xml.registry.infomodel.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(javax.xml.registry.infomodel.Concept concept) throws javax.xml.registry.JAXRException
concept
- associated concept
javax.xml.registry.JAXRException
javax.xml.registry.infomodel.Concept getConcept() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setDescription(java.lang.String description)
description
- description of typejava.lang.String getDescription()
javax.xml.registry.infomodel.InternationalString getI18NDescription() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void isExtensible(boolean extensible)
extensible
- true if arbitrary slots allowed, false otherwiseboolean isExtensible()
boolean areSlotsCreated()
void setUpdateProcess(boolean updateProcess)
java.util.Collection getSlotNames()
void addSlotDescription(CentraSiteSlotDescription slot)
slot
- slot to addvoid addSlotDescriptions(java.util.Collection slots) throws javax.xml.registry.JAXRException
slots
- collection of slot descriptions to add
javax.xml.registry.JAXRException
CentraSiteSlotDescription getSlotDescription(java.lang.String slotName)
slotName
- slot name to get description for
java.util.HashMap getSlotDescriptions()
void clearSlots()
java.util.Collection<CentraSiteClassificationAttribute> getClassificationAttributes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addClassificationAtribute(CentraSiteClassificationAttribute ca) throws javax.xml.registry.JAXRException
ca
- the classification attribute
javax.xml.registry.JAXRException
void addClassificationAtributes(java.util.Collection<CentraSiteClassificationAttribute> cas) throws javax.xml.registry.JAXRException
cas
- the collection of classification attributes
javax.xml.registry.JAXRException
void removeClassificationAtribute(CentraSiteClassificationAttribute ca) throws javax.xml.registry.JAXRException
ca
- the classification attribute
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteFileAttribute> getFileAttributes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addFileAtribute(CentraSiteFileAttribute fa) throws javax.xml.registry.JAXRException
fa
- the file attribute
javax.xml.registry.JAXRException
void addFileAtributes(java.util.Collection<CentraSiteFileAttribute> fas) throws javax.xml.registry.JAXRException
fas
- the collection of file attributes
javax.xml.registry.JAXRException
void removeFileAtribute(CentraSiteFileAttribute fa) throws javax.xml.registry.JAXRException
fa
- the file attribute
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteComputedAttribute> getComputedAttributes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addComputedAttribute(CentraSiteComputedAttribute cca) throws javax.xml.registry.JAXRException
cca
- the computed attribute
javax.xml.registry.JAXRException
void addComputedAttributes(java.util.Collection<CentraSiteComputedAttribute> ccas) throws javax.xml.registry.JAXRException
ccas
- the collection of computed attributes
javax.xml.registry.JAXRException
void removeComputedAttribute(CentraSiteComputedAttribute cca) throws javax.xml.registry.JAXRException
cca
- the computed attribute
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteRelationShipAttribute> getRelationShipAttributes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addRelationShipAtribute(CentraSiteRelationShipAttribute ra) throws javax.xml.registry.JAXRException
ra
- the relationship attribute
javax.xml.registry.JAXRException
void addRelationShipAtributes(java.util.Collection<CentraSiteRelationShipAttribute> ras) throws javax.xml.registry.JAXRException
ras
- the collection of relationship attributes
javax.xml.registry.JAXRException
void removeRelationShipAtribute(CentraSiteRelationShipAttribute ra) throws javax.xml.registry.JAXRException
ra
- the relationship attribute
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteJaxrAttribute> getJaxrAttributes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> getProfiles() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> getProfiles(java.lang.String conceptId) throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addProfiles(java.util.Collection<javax.xml.registry.infomodel.RegistryEntry> profiles) throws javax.xml.registry.JAXRException
profiles
- collection of profile instances
javax.xml.registry.JAXRException
void addProfile(javax.xml.registry.infomodel.RegistryEntry profile) throws javax.xml.registry.JAXRException
profile
- the profile to be added
javax.xml.registry.JAXRException
void removeProfile(javax.xml.registry.infomodel.RegistryEntry profile) throws javax.xml.registry.JAXRException
profile
- the profile to be removed
javax.xml.registry.JAXRException
java.util.Collection<java.lang.String> getProfileSequence() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setProfileSequence(java.util.Collection<java.lang.String> pseq) throws javax.xml.registry.JAXRException
pseq
- the collection of profile ids
javax.xml.registry.JAXRException
boolean isClassifiedWith(javax.xml.registry.infomodel.Concept concept) throws javax.xml.registry.JAXRException
concept
- the classification concept
javax.xml.registry.JAXRException
boolean isClassifiedWith(java.lang.String id) throws javax.xml.registry.JAXRException
id
- the classification concept id
javax.xml.registry.JAXRException
void addClassification(javax.xml.registry.infomodel.Concept concept) throws javax.xml.registry.JAXRException
concept
- the concept to be used for classification
javax.xml.registry.JAXRException
void addClassification(java.lang.String id) throws javax.xml.registry.JAXRException
id
- the id of the concept to be used for classification
javax.xml.registry.JAXRException
void removeClassification(javax.xml.registry.infomodel.Concept concept) throws javax.xml.registry.JAXRException
concept
- the concept to be removed
javax.xml.registry.JAXRException
void removeClassification(java.lang.String id) throws javax.xml.registry.JAXRException
id
- the id of the concept to be removed
javax.xml.registry.JAXRException
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 icon
java.lang.Exception
void setIconPath(java.lang.String serverFilePath) throws java.lang.Exception
serverFilePath
- temporary path to icon
java.lang.Exception
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
void setIconLink(javax.xml.registry.infomodel.ExternalLink iconLink)
iconLink
- link to type iconjavax.xml.registry.infomodel.ExternalLink getIconLink() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setLargeIconLink(javax.xml.registry.infomodel.ExternalLink largeIconLink)
largeIconLink
- link to LargeTypeIconjavax.xml.registry.infomodel.ExternalLink getLargeIconLink() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setXsdLink(javax.xml.registry.infomodel.ExternalLink xsdLink)
xsdLink
- link to schemajavax.xml.registry.infomodel.ExternalLink getXsdLink() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getSchemaName() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getDoctypeName() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String toXML() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if a JAXR error occursjava.lang.String toXmlForExport() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if a JAXR error occursvoid checkValidLocalName(java.lang.String value) throws java.lang.Exception
value
- the string to be checked
java.lang.Exception
void checkValidNameSpace(java.lang.String value) throws java.lang.Exception
value
- the string to be checked
java.lang.Exception
void save(RepositoryConnector repCon) throws java.lang.Exception
repCon
- repository connector
java.lang.Exception
- in case of any storage/retrieval failurevoid delete(RepositoryConnector repCon) throws java.lang.Exception
repCon
- repository connector
java.lang.Exception
- in case of any storage/retrieval failurevoid lock() throws javax.xml.registry.JAXRException
JAXRException,
- LockNotAvailableException
javax.xml.registry.JAXRException
java.lang.String ncName(java.lang.String value) throws javax.xml.registry.JAXRException
value
- the value to be converted to NCName
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteTypeDescription> getReverselyAggregatingTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteTypeDescription> getCompositedUsingTargetTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<CentraSiteTypeDescription> getAggregatedUsingTargetTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |