public class DictionaryQuery extends SingletonValueProcessorExtension implements java.io.Serializable
Service object that maintains no state other than the dictionary itself.
Queries include: isSubType, isAspect, hasProperty, getParentType etc.
Constructor and Description |
---|
DictionaryQuery() |
Modifier and Type | Method and Description |
---|---|
Dictionary.DictionaryAssoc[] |
getAssociations(java.lang.String ddclass)
getAssociations - return the target associations for the given dd class.
|
Dictionary.DictionaryAssoc[] |
getChildAssociations(java.lang.String ddclass)
getChildAssociations - return the child associations for the given dd class.
|
java.lang.String[] |
getDefaultAspects(java.lang.String type)
getDefaultAspects - return Array of default aspects for the given type.
|
java.lang.String |
getDescription(java.lang.String ddclass)
getDescription - return the description string for the given dd class.
|
java.lang.String |
getParent(java.lang.String ddclass)
getParent - return the parent for the given dd class.
|
Dictionary.DictionaryProperty[] |
getProperties(java.lang.String ddclass)
getProperties - return all properties for the given dd class.
|
Dictionary.DictionaryProperty[] |
getProperties(java.lang.String ddclass,
boolean includeDefaultAspects)
getProperties - return all properties for the given dd class.
|
Dictionary.DictionaryProperty |
getProperty(java.lang.String ddclass,
java.lang.String property)
getProperty - return a single named property for the given dd class.
|
Dictionary.DictionaryProperty |
getProperty(java.lang.String ddclass,
java.lang.String property,
boolean includeDefaultAspects)
getProperty - return a single named property for the given dd class, optionally
retrieve a property from the default aspects.
|
java.lang.String |
getTitle(java.lang.String ddclass)
getTitle - return the title string for the given dd class.
|
protected java.lang.String |
getValueName()
Output value name for informational and error messages to the administrator.
|
boolean |
hasDefaultAspect(java.lang.String type,
java.lang.String aspect)
hasDefaultAspect - return if the type definition has the default aspect applied..
|
boolean |
hasProperty(java.lang.String ddclass,
java.lang.String property)
hasProperty - return if a type or aspect has the given property definition.
|
boolean |
hasProperty(java.lang.String ddclass,
java.lang.String property,
boolean includeDefaultAspects)
hasProperty - return if a type or aspect has the given property definition.
|
boolean |
isAspect(java.lang.String ddclass)
isAspect - return if the supplied dd class is an aspect.
|
boolean |
isContainer(java.lang.String type)
isContainer - return if the specified type is a container
|
boolean |
isSubType(java.lang.String type,
java.lang.String isType)
isSubType - return if the supplied type is a sub-type of a given type.
|
boolean |
isType(java.lang.String ddclass)
isType - return if the supplied dd class is a type.
|
protected org.alfresco.web.scripts.Dictionary |
retrieveValue(java.lang.String userId,
java.lang.String storeId)
Method for implementing class to provide that retrieve the remote value from the appropriate
endpoint and API.
|
java.lang.String |
toString() |
getSingletonValue, getSingletonValue
public boolean isSubType(java.lang.String type, java.lang.String isType)
type
- Type to testisType
- Is the type a subtype of this type?public boolean hasDefaultAspect(java.lang.String type, java.lang.String aspect)
type
- Type to testaspect
- Aspect to look for in the default aspectspublic java.lang.String[] getDefaultAspects(java.lang.String type)
type
- Type to inspectpublic boolean isAspect(java.lang.String ddclass)
ddclass
- DD class to testpublic boolean isType(java.lang.String ddclass)
ddclass
- DD class to testpublic boolean hasProperty(java.lang.String ddclass, java.lang.String property)
ddclass
- Type or aspect to testproperty
- Property to look for in the type or aspect definitionpublic boolean hasProperty(java.lang.String ddclass, java.lang.String property, boolean includeDefaultAspects)
ddclass
- Type or aspect to testproperty
- Property to look for in the type or aspect definitionincludeDefaultAspects
- If true, check default aspects for the given property.public java.lang.String getTitle(java.lang.String ddclass)
ddclass
- DD class to inspectpublic java.lang.String getDescription(java.lang.String ddclass)
ddclass
- DD class to inspectpublic java.lang.String getParent(java.lang.String ddclass)
ddclass
- DD class to inspectpublic boolean isContainer(java.lang.String type)
type
- Type to inspectpublic Dictionary.DictionaryProperty getProperty(java.lang.String ddclass, java.lang.String property)
ddclass
- DD class to inspectproperty
- Property to look for in the type or aspect definitionpublic Dictionary.DictionaryProperty getProperty(java.lang.String ddclass, java.lang.String property, boolean includeDefaultAspects)
ddclass
- DD class to inspectproperty
- Property to look for in the type or aspect definitionincludeDefaultAspects
- If true, check default aspects for the given property.public Dictionary.DictionaryProperty[] getProperties(java.lang.String ddclass)
ddclass
- DD class to inspectpublic Dictionary.DictionaryProperty[] getProperties(java.lang.String ddclass, boolean includeDefaultAspects)
ddclass
- DD class to inspectincludeDefaultAspects
- If true, also retrieve properties from the default aspects.public Dictionary.DictionaryAssoc[] getAssociations(java.lang.String ddclass)
ddclass
- DD class to inspectpublic Dictionary.DictionaryAssoc[] getChildAssociations(java.lang.String ddclass)
ddclass
- DD class to inspectpublic java.lang.String toString()
toString
in class java.lang.Object
protected org.alfresco.web.scripts.Dictionary retrieveValue(java.lang.String userId, java.lang.String storeId) throws org.springframework.extensions.surf.exception.ConnectorServiceException
SingletonValueProcessorExtension
retrieveValue
in class SingletonValueProcessorExtension
userId
- Current user IdstoreId
- Current store Id if any - may be used if per-tenant values are requiredorg.springframework.extensions.surf.exception.ConnectorServiceException
protected java.lang.String getValueName()
SingletonValueProcessorExtension
getValueName
in class SingletonValueProcessorExtension
Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.