org.dmd.dmp.server.generated.dmw

Class GetRequestDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmp.server.generated.dmw.DMPMessageDMW

org.dmd.dmp.server.extended.DMPMessage

org.dmd.dmp.server.generated.dmw.RequestDMW

org.dmd.dmp.server.extended.Request

org.dmd.dmp.server.generated.dmw.GetRequestDMW

All Implemented Interfaces:

DmcContainerIF

Direct Known Subclasses:

GetRequest

public abstract class GetRequestDMW
extends Request

The GetRequest is used to retrieve objects.

Generated from the dmp schema at version 0.1

This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.dmp.server.extended.DMPMessage

request

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	GetRequestDMW()
	GetRequestDMW(DmcTypeModifierMV mods)
	GetRequestDMW(GetRequestDMO obj)
protected	GetRequestDMW(GetRequestDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addAttributeSelector(AttributeID value) Adds another attributeSelector value.
void	addAttributeSelector(DmcAttributeInfo value) Adds another DmcAttributeInfo value.
void	addAttributeSelector(Object value) Adds another attributeSelector value.
void	addTargets(DmcObjectName value) Adds another DmcObjectName value.
void	addTargets(NameContainer value) Adds another targets value.
void	addTargets(Object value) Adds another targets value.
boolean	attributeSelectorContains(AttributeID value)
boolean	attributeSelectorContains(DmcAttributeInfo value)
GetRequest	cloneIt()
void	delAttributeSelector(AttributeID value) Deletes a attributeSelector value.
void	delAttributeSelector(Object value) Deletes a attributeSelector value.
void	delTargets(NameContainer value) Deletes a targets value.
void	delTargets(Object value) Deletes a targets value.
HashSet<AttributeID>	getAttributeSelectorCopy()
boolean	getAttributeSelectorHasValue()
boolean	getAttributeSelectorIsEmpty()
AttributeIDIterableDMW	getAttributeSelectorIterable()
int	getAttributeSelectorSize()
Integer	getBlockingFactor()
ClassFilter	getClassFilter()
GetRequestDMO	getDMO()
String	getFilter()
ClassDefinition	getFilterByClass()
GetRequest	getModificationRecorder()
ScopeEnum	getScope()
String	getSlice()
ArrayList<NameContainer>	getTargetsCopy()
boolean	getTargetsHasValue()
boolean	getTargetsIsEmpty()
NameContainerIterableDMW	getTargetsIterable()
int	getTargetsSize()
Boolean	isCacheResponse()
Boolean	isRegisterForEvents()
void	remAttributeSelector() Removes the attributeSelector attribute value.
void	remBlockingFactor() Removes the blockingFactor attribute value.
void	remCacheResponse() Removes the cacheResponse attribute value.
void	remClassFilter() Removes the classFilter attribute value.
void	remFilter() Removes the filter attribute value.
void	remFilterByClass() Removes the filterByClass attribute value.
void	remRegisterForEvents() Removes the registerForEvents attribute value.
void	remScope() Removes the scope attribute value.
void	remSlice() Removes the slice attribute value.
void	remTargets() Removes the targets attribute value.
void	setBlockingFactor(Integer value) Sets blockingFactor to the specified value.
void	setBlockingFactor(Object value) Sets blockingFactor to the specified value.
void	setCacheResponse(Boolean value) Sets cacheResponse to the specified value.
void	setCacheResponse(Object value) Sets cacheResponse to the specified value.
void	setClassFilter(ClassFilter value) Sets classFilter to the specified value.
void	setClassFilter(Object value) Sets classFilter to the specified value.
void	setFilter(Object value) Sets filter to the specified value.
void	setFilter(String value) Sets filter to the specified value.
void	setFilterByClass(ClassDefinition value) Sets the filterByClass to the specified value.
void	setFilterByClass(Object value) Sets the filterByClass to the specified value.
void	setRegisterForEvents(Boolean value) Sets registerForEvents to the specified value.
void	setRegisterForEvents(Object value) Sets registerForEvents to the specified value.
void	setScope(Object value) Sets scope to the specified value.
void	setScope(ScopeEnum value) Sets scope to the specified value.
void	setSlice(Object value) Sets slice to the specified value.
void	setSlice(String value) Sets slice to the specified value.
boolean	targetsContains(DmcObjectName value)
boolean	targetsContains(NameContainer value)

Methods inherited from class org.dmd.dmp.server.extended.Request

fillError, fillStandard, getErrorResponse, getUInfo, getUserInfo, setSessionInfo, setUserInfo

Methods inherited from class org.dmd.dmp.server.generated.dmw.RequestDMW

getHandlerID, getOriginatorID, getResponseFormat, getSessionID, getTimeoutSeconds, getUserName, isNotifyOriginator, isReadableFormat, remHandlerID, remNotifyOriginator, remOriginatorID, remReadableFormat, remResponseFormat, remSessionID, remTimeoutSeconds, remUserName, setHandlerID, setHandlerID, setNotifyOriginator, setNotifyOriginator, setOriginatorID, setOriginatorID, setReadableFormat, setReadableFormat, setResponseFormat, setResponseFormat, setSessionID, setSessionID, setTimeoutSeconds, setTimeoutSeconds, setUserName, setUserName

Methods inherited from class org.dmd.dmp.server.extended.DMPMessage

getLastRequestID, getServletRequest, removeLastRequestID

Methods inherited from class org.dmd.dmp.server.generated.dmw.DMPMessageDMW

addNvp, addNvp, addRequestID, addRequestID, delNvp, delNvp, delRequestID, delRequestID, getNvpCopy, getNvpHasValue, getNvpIsEmpty, getNvpIterable, getNvpSize, getRequestIDCopy, getRequestIDHasValue, getRequestIDIsEmpty, getRequestIDIterable, getRequestIDSize, getTimeMS, isTrackingEnabled, nvpContains, remNvp, remRequestID, remTimeMS, remTrackingEnabled, requestIDContains, setTimeMS, setTimeMS, setTrackingEnabled, setTrackingEnabled

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GetRequestDMW

public GetRequestDMW()

GetRequestDMW

public GetRequestDMW(DmcTypeModifierMV mods)

GetRequestDMW

public GetRequestDMW(GetRequestDMO obj)

GetRequestDMW

protected GetRequestDMW(GetRequestDMO obj,
                        ClassDefinition cd)

Method Detail

getModificationRecorder

public GetRequest getModificationRecorder()

Specified by:

getModificationRecorder in class RequestDMW

cloneIt

public GetRequest cloneIt()

getDMO

public GetRequestDMO getDMO()

Overrides:

getDMO in class RequestDMW

getAttributeSelectorSize

public int getAttributeSelectorSize()

Returns:

The number of AttributeID items.

getAttributeSelectorIsEmpty

public boolean getAttributeSelectorIsEmpty()

Returns:

true if there are no AttributeIDDMO items.

getAttributeSelectorHasValue

public boolean getAttributeSelectorHasValue()

Returns:

true if there are any AttributeIDDMO items.

getAttributeSelectorIterable

public AttributeIDIterableDMW getAttributeSelectorIterable()

Returns:

An Iterator of AttributeID objects.

addAttributeSelector

public void addAttributeSelector(Object value)
                          throws DmcValueException

Adds another attributeSelector value.

Parameters:

value - A value compatible with AttributeID

Throws:

DmcValueException - if value is incorrect

addAttributeSelector

public void addAttributeSelector(AttributeID value)

Adds another attributeSelector value.

Parameters:

value - A value compatible with AttributeID

addAttributeSelector

public void addAttributeSelector(DmcAttributeInfo value)

Adds another DmcAttributeInfo value.

Parameters:

value - A value compatible with DmcAttributeInfo

attributeSelectorContains

public boolean attributeSelectorContains(AttributeID value)

Parameters:

value - A value compatible with AttributeID

Returns:

true if the collection contains the attributeSelector value.

attributeSelectorContains

public boolean attributeSelectorContains(DmcAttributeInfo value)

Parameters:

value - A value compatible with DmcAttributeInfo

Returns:

true if the collection contains the DmcAttributeInfo value.

getAttributeSelectorCopy

public HashSet<AttributeID> getAttributeSelectorCopy()

Returns:

A COPY of the collection of AttributeID objects.

delAttributeSelector

public void delAttributeSelector(Object value)
                          throws DmcValueException

Deletes a attributeSelector value.

Parameters:

value - The AttributeID to be deleted from set of attribute values.

Throws:

DmcValueException - if value is incorrect

delAttributeSelector

public void delAttributeSelector(AttributeID value)

Deletes a attributeSelector value.

Parameters:

value - The AttributeID to be deleted from set of attribute values.

remAttributeSelector

public void remAttributeSelector()

Removes the attributeSelector attribute value.

getBlockingFactor

public Integer getBlockingFactor()

setBlockingFactor

public void setBlockingFactor(Object value)
                       throws DmcValueException

Sets blockingFactor to the specified value.

Parameters:

value - A value compatible with DmcTypeInteger

Throws:

DmcValueException

setBlockingFactor

public void setBlockingFactor(Integer value)

Sets blockingFactor to the specified value.

Parameters:

value - Integer

remBlockingFactor

public void remBlockingFactor()

Removes the blockingFactor attribute value.

isCacheResponse

public Boolean isCacheResponse()

setCacheResponse

public void setCacheResponse(Object value)
                      throws DmcValueException

Sets cacheResponse to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

DmcValueException

setCacheResponse

public void setCacheResponse(Boolean value)

Sets cacheResponse to the specified value.

Parameters:

value - Boolean

remCacheResponse

public void remCacheResponse()

Removes the cacheResponse attribute value.

getClassFilter

public ClassFilter getClassFilter()

setClassFilter

public void setClassFilter(Object value)
                    throws DmcValueException

Sets classFilter to the specified value.

Parameters:

value - A value compatible with DmcTypeClassFilter

Throws:

DmcValueException

setClassFilter

public void setClassFilter(ClassFilter value)

Sets classFilter to the specified value.

Parameters:

value - ClassFilter

remClassFilter

public void remClassFilter()

Removes the classFilter attribute value.

getFilter

public String getFilter()

setFilter

public void setFilter(Object value)
               throws DmcValueException

Sets filter to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setFilter

public void setFilter(String value)

Sets filter to the specified value.

Parameters:

value - String

remFilter

public void remFilter()

Removes the filter attribute value.

getFilterByClass

public ClassDefinition getFilterByClass()

Returns:

A ClassDefinition object.

setFilterByClass

public void setFilterByClass(ClassDefinition value)

Sets the filterByClass to the specified value.

Parameters:

value - A value compatible with ClassDefinitionREF

setFilterByClass

public void setFilterByClass(Object value)
                      throws DmcValueException

Sets the filterByClass to the specified value.

Parameters:

value - A value compatible with ClassDefinitionREF

Throws:

DmcValueException - is the value is incorrect

remFilterByClass

public void remFilterByClass()

Removes the filterByClass attribute value.

isRegisterForEvents

public Boolean isRegisterForEvents()

setRegisterForEvents

public void setRegisterForEvents(Object value)
                          throws DmcValueException

Sets registerForEvents to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

DmcValueException

setRegisterForEvents

public void setRegisterForEvents(Boolean value)

Sets registerForEvents to the specified value.

Parameters:

value - Boolean

remRegisterForEvents

public void remRegisterForEvents()

Removes the registerForEvents attribute value.

getScope

public ScopeEnum getScope()

setScope

public void setScope(Object value)
              throws DmcValueException

Sets scope to the specified value.

Parameters:

value - A value compatible with DmcTypeScopeEnum

Throws:

DmcValueException

setScope

public void setScope(ScopeEnum value)

Sets scope to the specified value.

Parameters:

value - ScopeEnum

remScope

public void remScope()

Removes the scope attribute value.

getSlice

public String getSlice()

setSlice

public void setSlice(Object value)
              throws DmcValueException

Sets slice to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setSlice

public void setSlice(String value)

Sets slice to the specified value.

Parameters:

value - String

remSlice

public void remSlice()

Removes the slice attribute value.

getTargetsSize

public int getTargetsSize()

Returns:

The number of NameContainer items.

getTargetsIsEmpty

public boolean getTargetsIsEmpty()

Returns:

true if there are no NameContainerDMO items.

getTargetsHasValue

public boolean getTargetsHasValue()

Returns:

true if there are any NameContainerDMO items.

getTargetsIterable

public NameContainerIterableDMW getTargetsIterable()

Returns:

An Iterator of NameContainer objects.

addTargets

public void addTargets(Object value)
                throws DmcValueException

Adds another targets value.

Parameters:

value - A value compatible with NameContainer

Throws:

DmcValueException - if value is incorrect

addTargets

public void addTargets(NameContainer value)

Adds another targets value.

Parameters:

value - A value compatible with NameContainer

addTargets

public void addTargets(DmcObjectName value)

Adds another DmcObjectName value.

Parameters:

value - A value compatible with DmcObjectName

targetsContains

public boolean targetsContains(NameContainer value)

Parameters:

value - A value compatible with NameContainer

Returns:

true if the collection contains the targets value.

targetsContains

public boolean targetsContains(DmcObjectName value)

Parameters:

value - A value compatible with DmcObjectName

Returns:

true if the collection contains the DmcObjectName value.

getTargetsCopy

public ArrayList<NameContainer> getTargetsCopy()

Returns:

A COPY of the collection of NameContainer objects.

delTargets

public void delTargets(Object value)
                throws DmcValueException

Deletes a targets value.

Parameters:

value - The NameContainer to be deleted from set of attribute values.

Throws:

DmcValueException - if value is incorrect

delTargets

public void delTargets(NameContainer value)

Deletes a targets value.

Parameters:

value - The NameContainer to be deleted from set of attribute values.

remTargets

public void remTargets()

Removes the targets attribute value.