|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.extensions.webscripts.processor.BaseProcessorExtension
org.alfresco.web.scripts.DictionaryQuery
public class DictionaryQuery
Slingleton scripting host object provided to allows scripts to execute basic Alfresco Data Dictionary model queries.
Service object that maintains no state other than the dictionary itself.
Queries include: isSubType, isAspect, hasProperty, getParentType etc.
Nested Class Summary | |
---|---|
static class |
DictionaryQuery.DictionaryAssoc
Simple structure class representing a single Data Dictionary association instance. |
static class |
DictionaryQuery.DictionaryProperty
Simple structure class representing a single Data Dictionary property instance. |
Constructor Summary | |
---|---|
DictionaryQuery()
|
Method Summary | |
---|---|
DictionaryQuery.DictionaryAssoc[] |
getAssociations(java.lang.String ddclass)
getAssociations - return the target associations for the given dd class. |
DictionaryQuery.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. |
DictionaryQuery.DictionaryProperty[] |
getProperties(java.lang.String ddclass)
getProperties - return all properties for the given dd class. |
DictionaryQuery.DictionaryProperty[] |
getProperties(java.lang.String ddclass,
boolean includeDefaultAspects)
getProperties - return all properties for the given dd class. |
DictionaryQuery.DictionaryProperty |
getProperty(java.lang.String ddclass,
java.lang.String property)
getProperty - return a single named property for the given dd class. |
DictionaryQuery.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. |
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. |
java.lang.String |
toString()
|
Methods inherited from class org.springframework.extensions.webscripts.processor.BaseProcessorExtension |
---|
getExtensionName, register, setExtensionName, setProcessors |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DictionaryQuery()
Method Detail |
---|
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 aspects
public java.lang.String[] getDefaultAspects(java.lang.String type)
type
- Type to inspect
public boolean isAspect(java.lang.String ddclass)
ddclass
- DD class to test
public boolean isType(java.lang.String ddclass)
ddclass
- DD class to test
public 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 definition
public 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 inspect
public java.lang.String getDescription(java.lang.String ddclass)
ddclass
- DD class to inspect
public java.lang.String getParent(java.lang.String ddclass)
ddclass
- DD class to inspect
public boolean isContainer(java.lang.String type)
type
- Type to inspect
public DictionaryQuery.DictionaryProperty getProperty(java.lang.String ddclass, java.lang.String property)
ddclass
- DD class to inspectproperty
- Property to look for in the type or aspect definition
public DictionaryQuery.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 DictionaryQuery.DictionaryProperty[] getProperties(java.lang.String ddclass)
ddclass
- DD class to inspect
public DictionaryQuery.DictionaryProperty[] getProperties(java.lang.String ddclass, boolean includeDefaultAspects)
ddclass
- DD class to inspectincludeDefaultAspects
- If true, also retrieve properties from the default aspects.
public DictionaryQuery.DictionaryAssoc[] getAssociations(java.lang.String ddclass)
ddclass
- DD class to inspect
public DictionaryQuery.DictionaryAssoc[] getChildAssociations(java.lang.String ddclass)
ddclass
- DD class to inspect
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |