org.dmd.dms.generated.dmw

Class ActionDefinitionDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.dms.generated.dmw.DmsDefinitionDMW

org.dmd.dms.DmsDefinition

org.dmd.dms.generated.dmw.ActionDefinitionDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

ActionDefinition

public class ActionDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF

This class is used to define the actions that may be triggered on\n an object.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMWClasses(MetaGenerator.java:1649)

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActionDefinitionDMW()
protected	ActionDefinitionDMW(ClassDefinition cd)
protected	ActionDefinitionDMW(DmcObject obj)
protected	ActionDefinitionDMW(DmcObject obj, ClassDefinition cd)
protected	ActionDefinitionDMW(String mn)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addAttachToClass(ClassDefinition value) Adds another attachToClass value.
void	addDescription(Object value) Adds another description value.
DmcAttribute<?>	addMayParm(AttributeDefinition value) Adds another mayParm value.
DmcAttribute<?>	addMayReturn(AttributeDefinition value) Adds another mayReturn value.
DmcAttribute<?>	addMustParm(AttributeDefinition value) Adds another mustParm value.
DmcAttribute<?>	addMustReturn(AttributeDefinition value) Adds another mustReturn value.
ClassDefinitionIterableDMW	getAttachToClass() Indicates the classes of object to which an action is to be attached.\n This mechanism allows for the extension of a class's behaviour without having\n to alter the schema of the class involved.
int	getAttachToClassSize()
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
Iterator<String>	getDescriptionWithNewlines()
ActionDefinitionDMO	getDMO()
Boolean	getIsGetAction() This flag indicates if an Action is merely a data retrieval (get) Action.\n Actions that are flagged with this attribute set to true will be executable\n even when the server is in a read-only mode because they don't actually\n alter data.
AttributeDefinitionIterableDMW	getMayParm() Indicates the set of parameters that an action MAY have.
int	getMayParmSize()
AttributeDefinitionIterableDMW	getMayReturn() Indicates the set of return vals that may be returned as part of a\n particular action response message.
int	getMayReturnSize()
Boolean	getMaySendProgress() This flag is used to indicate if a particular request might\n result in progress indications being sent.
AttributeDefinitionIterableDMW	getMustParm() Indicates the set of parameters that an action MUST have.
int	getMustParmSize()
AttributeDefinitionIterableDMW	getMustReturn() Indicates the set of return vals that must be returned as part of a\n particular action response message.
int	getMustReturnSize()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
String	getObsoleteVersion() This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility.
void	setDmcObject(DmcObject obj) Sets the core object.
void	setIsGetAction(Object value) Sets isGetAction to the specified value.
void	setMaySendProgress(Object value) Sets maySendProgress to the specified value.
void	setName(Object value) Sets name to the specified value.
void	setObsoleteVersion(Object value) Sets obsoleteVersion to the specified value.

Methods inherited from class org.dmd.dms.DmsDefinition

getDmcObject

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW

addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName, getNameOfModuleWhereThisCameFrom

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Constructor Detail

ActionDefinitionDMW

protected ActionDefinitionDMW()

ActionDefinitionDMW

protected ActionDefinitionDMW(DmcObject obj)

ActionDefinitionDMW

protected ActionDefinitionDMW(DmcObject obj,
                              ClassDefinition cd)

ActionDefinitionDMW

protected ActionDefinitionDMW(ClassDefinition cd)

ActionDefinitionDMW

protected ActionDefinitionDMW(String mn)
                       throws DmcValueException

Throws:

DmcValueException

Method Detail

setDmcObject

public void setDmcObject(DmcObject obj)

Description copied from class: DmcContainer

Sets the core object.

Specified by:

setDmcObject in interface DmcContainerIF

Overrides:

setDmcObject in class DmsDefinition

Parameters:

obj - The core object.

getDMO

public ActionDefinitionDMO getDMO()

Overrides:

getDMO in class DmsDefinitionDMW

getName

public DefinitionName getName()

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class DmsDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DmsDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if the value is incorrect

getDescription

public Iterator<String> getDescription()

The description attribute is used to provide descriptive\n documentation for schema related definitions. The text provided should conform\n to XHTML concepts since it will be dumped in the context of the generated HTML\n documentation.

Overrides:

getDescription in class DSDefinitionDMW

Returns:

the String

getDescriptionWithNewlines

public Iterator<String> getDescriptionWithNewlines()

Overrides:

getDescriptionWithNewlines in class DSDefinitionDMW

addDescription

public void addDescription(Object value)
                    throws DmcValueException

Adds another description value.

Overrides:

addDescription in class DSDefinitionDMW

Parameters:

value - A value compatible with DmcTypeStringMV

Throws:

DmcValueException - if the value is incorrect

getDescriptionSize

public int getDescriptionSize()

Overrides:

getDescriptionSize in class DSDefinitionDMW

Returns:

the number of description values.

getMustParm

public AttributeDefinitionIterableDMW getMustParm()

Indicates the set of parameters that an action MUST have. When\n accessed in Java, this is a set of references to AttributeDefinition objects.

Returns:

the AttributeDefinition

addMustParm

public DmcAttribute<?> addMustParm(AttributeDefinition value)
                            throws DmcValueException

Adds another mustParm value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMustParmSize

public int getMustParmSize()

Returns:

the number of mustParm values.

getMayParm

public AttributeDefinitionIterableDMW getMayParm()

Indicates the set of parameters that an action MAY have. When accessed\n in Java, this is a set of references to AttributeDefinition objects.

Returns:

the AttributeDefinition

addMayParm

public DmcAttribute<?> addMayParm(AttributeDefinition value)
                           throws DmcValueException

Adds another mayParm value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMayParmSize

public int getMayParmSize()

Returns:

the number of mayParm values.

getMustReturn

public AttributeDefinitionIterableDMW getMustReturn()

Indicates the set of return vals that must be returned as part of a\n particular action response message.

Returns:

the AttributeDefinition

addMustReturn

public DmcAttribute<?> addMustReturn(AttributeDefinition value)
                              throws DmcValueException

Adds another mustReturn value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMustReturnSize

public int getMustReturnSize()

Returns:

the number of mustReturn values.

getMayReturn

public AttributeDefinitionIterableDMW getMayReturn()

Indicates the set of return vals that may be returned as part of a\n particular action response message.

Returns:

the AttributeDefinition

addMayReturn

public DmcAttribute<?> addMayReturn(AttributeDefinition value)
                             throws DmcValueException

Adds another mayReturn value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getMayReturnSize

public int getMayReturnSize()

Returns:

the number of mayReturn values.

getAttachToClass

public ClassDefinitionIterableDMW getAttachToClass()

Indicates the classes of object to which an action is to be attached.\n This mechanism allows for the extension of a class's behaviour without having\n to alter the schema of the class involved. This can be viewed as the auxiliary\n class equivalent for behaviour.

Returns:

the ClassDefinition

addAttachToClass

public DmcAttribute<?> addAttachToClass(ClassDefinition value)
                                 throws DmcValueException

Adds another attachToClass value.

Parameters:

value - A value compatible with ClassDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getAttachToClassSize

public int getAttachToClassSize()

Returns:

the number of attachToClass values.

getIsGetAction

public Boolean getIsGetAction()

This flag indicates if an Action is merely a data retrieval (get) Action.\n Actions that are flagged with this attribute set to true will be executable\n even when the server is in a read-only mode because they don't actually\n alter data.

Returns:

the Boolean

setIsGetAction

public void setIsGetAction(Object value)
                    throws DmcValueException

Sets isGetAction to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getObsoleteVersion

public String getObsoleteVersion()

This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility. Instead, you\n should mark them as obsolete.

Returns:

the String

setObsoleteVersion

public void setObsoleteVersion(Object value)
                        throws DmcValueException

Sets obsoleteVersion to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getMaySendProgress

public Boolean getMaySendProgress()

This flag is used to indicate if a particular request might\n result in progress indications being sent. Although primarily intended as a\n documentation aspect, this flag is used within the TL1 subsystem to allow for\n the creation of a response handler for node requests that send progress text.

Returns:

the Boolean

setMaySendProgress

public void setMaySendProgress(Object value)
                        throws DmcValueException

Sets maySendProgress to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DmsDefinition

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DmsDefinitionDMW

Returns:

The name attribute.