com.filenet.wcm.toolkit.server.util.xml
Class WcmXMLSubscription

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
      extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
          extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
              extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLSubscription

public class WcmXMLSubscription
extends WcmXMLProperties

WcmXMLProperties derived class for manipulating the Workflow Subscription specific XML


Field Summary
static java.lang.String ELEM_EVENTACTION
          XPath for event action node
static java.lang.String ELEM_SOURCE
          XPath for source node
static java.lang.String ELEM_TARGET
          XPath for target node
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
ELEM_PROPERTY
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
ELEM_CLASSID, ELEM_CLASSNAME, ELEM_OBJECT, ELEM_OBJECTSTORE
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
ELEM_OBJECTSET, thisDoc
 
Method Summary
 org.w3c.dom.Element createWorkflowsubscriptionElement()
          Create the workflowsubscription Element
protected  org.w3c.dom.Element getEventActionElement()
          Returns the Element for the eventaction
 java.lang.String getEventActionId()
          Returns the eventaction id
protected  org.w3c.dom.Element getSourceElement()
          Returns the source Element
 java.lang.String getSourceId()
          Returns the id of the source
 java.lang.String getSourceLabel()
          Returns the Label of the source
 java.lang.String getSourceVernum()
          returns the version number
 java.lang.String getSubscriptionId()
           
 java.lang.String getSubscriptionLabel()
           
 java.lang.String getTargetClass()
          Returns the target class
protected  org.w3c.dom.Element getTargetElement()
          Get the target Element
 java.lang.String getTargetId()
          Returns the target Id
 int getTargetType()
          Returns the target type
protected  org.w3c.dom.Element getWorkflowsubscription()
          Returns the workflowsubscription Element or creates a new one
static WcmXMLSubscription getXMLSubscription()
          get method returns a new instance of this object
static WcmXMLSubscription getXMLSubscription(org.w3c.dom.Document newXMLSubscription)
          get method creates or contains the Document as one of this type
static org.w3c.dom.Document getXMLSubscriptions(WcmSearchDataProvider sdp, java.lang.String XSLFile, java.lang.String objectStore)
          Deprecated. use getXMLSubscriptionsRelative
static org.w3c.dom.Document getXMLSubscriptionsRelative(WcmSearchDataProvider sdp, java.lang.String XSLFile, java.lang.String objectStore)
          Get Subscription XML using ADO query on the indicated object store.
 boolean isSourceModified()
          Indicates if the source has been modified
 org.w3c.dom.Element setDocumentTarget(java.lang.String sName, java.lang.String sVerSerId, java.lang.String sId, java.lang.String sVernum)
          Handle setting document targets
 void setEventActionId(java.lang.String sId)
          Set the eventaction id
 org.w3c.dom.Element setObjectStoreId(java.lang.String sObjectStoreName)
          Clear properties that may be unapplicable on a target change, then call base class method
 void setSourceId(java.lang.String sId)
          Sets the source Id
 void setSourceLabel(java.lang.String sLabel)
          Sets the source Label
 org.w3c.dom.Element setTarget(int nType, java.lang.String sName, java.lang.String sId)
          Handles setting the target for all but document target types
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
addMultiObjectValues, addMultiValues, addMultiValues, createComponentRelationshipElement, createCustomObjectElement, createDocumentElement, createFolderElement, createLinkElement, createPropertiesElement, createPropertyElement, createPropertyElement, createPropertyElement, createPropertyElement, getComponentRelationship, getCustomObject, getDocument, getFolder, getLink, getPropertiesElement, getPropertyByID, getPropertyByID, getPropertyByName, getPropertyByName, getPropertySymnameById, getPropertyValueByID, getPropertyValueByName, getPropertyValueByName, getPropertyValueIdByName, getXMLProperties, getXMLProperties, removeAllPropValues, removeObjectValuesByName, removeProperties, removePropertyByName, removePropValues, removeValuesByName, removeValuesByName, setObjectElement, setObjectElement, setPropertyByID, setPropertyByName, setPropertyByName, setPropertyElement
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
getClassdescElement, getClassId, getClassName, getObjectElement, getObjectId, getObjectStoreElement, getObjectStoreId, getObjectTagValue, getObjectXPath, getXMLObject, getXMLObject, setClassDescription, setObjectTagValue, setObjectXPath
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
createCDATAChildElement, createChildElement, createChildElement, createNamespace, getDocumentImpl, getElement, getElement, getElementText, getNodeList, getThis
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEM_TARGET

public static final java.lang.String ELEM_TARGET
XPath for target node

See Also:
Constant Field Values

ELEM_SOURCE

public static final java.lang.String ELEM_SOURCE
XPath for source node

See Also:
Constant Field Values

ELEM_EVENTACTION

public static final java.lang.String ELEM_EVENTACTION
XPath for event action node

See Also:
Constant Field Values
Method Detail

getXMLSubscription

public static WcmXMLSubscription getXMLSubscription()
                                             throws java.lang.Exception
get method returns a new instance of this object

Returns:
WcmXMLSubscription The new WcmXMLSubscription object
Throws:
java.lang.Exception

getXMLSubscriptions

public static org.w3c.dom.Document getXMLSubscriptions(WcmSearchDataProvider sdp,
                                                       java.lang.String XSLFile,
                                                       java.lang.String objectStore)
                                                throws java.lang.Exception
Deprecated. use getXMLSubscriptionsRelative

Throws:
java.lang.Exception

getXMLSubscriptionsRelative

public static org.w3c.dom.Document getXMLSubscriptionsRelative(WcmSearchDataProvider sdp,
                                                               java.lang.String XSLFile,
                                                               java.lang.String objectStore)
                                                        throws java.lang.Exception
Get Subscription XML using ADO query on the indicated object store.

Parameters:
sdp - The Search data provider that will perform the search
XSLFile - The XSL file for transforming the ADO
objectStore - The object store to search
Returns:
The Subscription XML
Throws:
java.lang.Exception

setObjectStoreId

public org.w3c.dom.Element setObjectStoreId(java.lang.String sObjectStoreName)
                                     throws java.lang.Exception
Clear properties that may be unapplicable on a target change, then call base class method

Overrides:
setObjectStoreId in class WcmXMLObject
Parameters:
sObjectStoreName -
Returns:
Element for the id
Throws:
java.lang.Exception

getXMLSubscription

public static WcmXMLSubscription getXMLSubscription(org.w3c.dom.Document newXMLSubscription)
                                             throws java.lang.Exception
get method creates or contains the Document as one of this type

Parameters:
newXMLSubscription - The Document to contain
Returns:
WcmXMLSubscription The new WcmXMLSubscription object
Throws:
java.lang.Exception

getWorkflowsubscription

protected org.w3c.dom.Element getWorkflowsubscription()
                                               throws java.lang.Exception
Returns the workflowsubscription Element or creates a new one

Returns:
The workflowsubscription Element
Throws:
java.lang.Exception

createWorkflowsubscriptionElement

public org.w3c.dom.Element createWorkflowsubscriptionElement()
                                                      throws java.lang.Exception
Create the workflowsubscription Element

Returns:
The new workflowsubscription Element
Throws:
java.lang.Exception

getTargetElement

protected org.w3c.dom.Element getTargetElement()
                                        throws java.lang.Exception
Get the target Element

Returns:
The target Element
Throws:
java.lang.Exception

getEventActionElement

protected org.w3c.dom.Element getEventActionElement()
                                             throws java.lang.Exception
Returns the Element for the eventaction

Returns:
The Element for the eventaction
Throws:
java.lang.Exception

getEventActionId

public java.lang.String getEventActionId()
                                  throws java.lang.Exception
Returns the eventaction id

Returns:
The eventaction id
Throws:
java.lang.Exception

setEventActionId

public void setEventActionId(java.lang.String sId)
                      throws java.lang.Exception
Set the eventaction id

Parameters:
sId - for the eventaction
Throws:
java.lang.Exception

getSourceElement

protected org.w3c.dom.Element getSourceElement()
                                        throws java.lang.Exception
Returns the source Element

Returns:
The source Element
Throws:
java.lang.Exception

getSourceId

public java.lang.String getSourceId()
                             throws java.lang.Exception
Returns the id of the source

Returns:
The Source Id
Throws:
java.lang.Exception

getSourceLabel

public java.lang.String getSourceLabel()
                                throws java.lang.Exception
Returns the Label of the source

Returns:
The Source Label
Throws:
java.lang.Exception

getSubscriptionId

public java.lang.String getSubscriptionId()
                                   throws java.lang.Exception
Throws:
java.lang.Exception

getSubscriptionLabel

public java.lang.String getSubscriptionLabel()
                                      throws java.lang.Exception
Throws:
java.lang.Exception

isSourceModified

public boolean isSourceModified()
                         throws java.lang.Exception
Indicates if the source has been modified

Returns:
true of false indicating if the source has been modified
Throws:
java.lang.Exception

getSourceVernum

public java.lang.String getSourceVernum()
                                 throws java.lang.Exception
returns the version number

Returns:
The version number: major.minor
Throws:
java.lang.Exception

setSourceId

public void setSourceId(java.lang.String sId)
                 throws java.lang.Exception
Sets the source Id

Parameters:
sId - Value to use
Throws:
java.lang.Exception

setSourceLabel

public void setSourceLabel(java.lang.String sLabel)
                    throws java.lang.Exception
Sets the source Label

Parameters:
sLabel - Value to use
Throws:
java.lang.Exception

setDocumentTarget

public org.w3c.dom.Element setDocumentTarget(java.lang.String sName,
                                             java.lang.String sVerSerId,
                                             java.lang.String sId,
                                             java.lang.String sVernum)
                                      throws java.lang.Exception
Handle setting document targets

Parameters:
sName - The name of the document target
sVerSerId - The version series id for the document target
sId - The id for the document target
sVernum - The version number for the document target
Returns:
Element The document target
Throws:
java.lang.Exception

getTargetId

public java.lang.String getTargetId()
                             throws java.lang.Exception
Returns the target Id

Returns:
id The target Id
Throws:
java.lang.Exception

getTargetClass

public java.lang.String getTargetClass()
                                throws java.lang.Exception
Returns the target class

Returns:
String The target class name.
Throws:
java.lang.Exception

getTargetType

public int getTargetType()
                  throws java.lang.Exception
Returns the target type

Returns:
The target type
Throws:
java.lang.Exception

setTarget

public org.w3c.dom.Element setTarget(int nType,
                                     java.lang.String sName,
                                     java.lang.String sId)
                              throws java.lang.Exception
Handles setting the target for all but document target types

Parameters:
nType - The Object Type
sName - The target name
sId - The target Id
Returns:
target Element
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.