Package de.elo.ix.client.feed
Class Action
java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.feed.Action
- All Implemented Interfaces:
Serializable
This class describes an entry in a document feed. There are three kinds of entries/actions in
general. First, an action can be a comment added manually by a user. Second, scripts or programs
can insert actions e.g. to notify about a particular state. Third, actions are generated by the
system e.g. when a new document version is created. In order to add an action to a feed, call
FeedService.checkinAction(de.elo.ix.client.ClientInfo, Action, ActionZ). User comments
can have a parent action to support a two level hierarchy of entries.- Since:
- 9.00.000.003
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringRaw ACL representation.protected AclItem[]Access control list.protected intCounts the number of updates.protected StringCreate date.protected DocVersionDocument version object.protected StringGUID of the associated document version.protected StringFeed GUID.protected StringAction GUID.protected List<ActionHistory> Change history of text member.protected StringParent action GUID.protected StringComment text.protected StringTime stamp.protected StringTimestamp of this object's last export by the replication.protected EActionTypeAction type.protected StringUpdate date.protected StringUser GUID.protected intUser ID.protected StringUser name.protected WFDiagramWorkflow object.protected StringGUID of the associated workflow.Fields inherited from class byps.BValueClass
bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAcl()AclItem[]Note that no GUID is set for the AND groups of the ACL items.intgetGuid()getText()getType()intvoidvoidsetAclItems(AclItem[] aclItems) voidsetChangeCounter(int changeCounter) voidsetCreateDateIso(String createDateIso) voidsetDocVersion(DocVersion docVersion) voidsetDocVersionGuid(String docVersionGuid) voidsetFeedGuid(String feedGuid) voidvoidsetHistory(List<ActionHistory> history) voidsetParentGuid(String parentGuid) voidvoidvoidsetTStampSync(String TStampSync) voidsetType(EActionType type) voidsetUpdateDateIso(String lastModifiedIso) voidsetUserGuid(String userGuid) voidsetUserId(int userId) voidsetUserName(String userName) voidsetWorkflow(WFDiagram workflow) voidsetWorkflowGuid(String workflowGuid) toString()Methods inherited from class byps.BValueClass
getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper
-
Field Details
-
guid
Action GUID. Unique identifier. -
type
Action type. -
feedGuid
Feed GUID. This action belongs to the feed identified by this GUID. -
parentGuid
Parent action GUID. This element is only valid for user comments,EActionType.UserComment. If not empty, this action is subordinated under the action given by this GUID. -
userGuid
User GUID. The GUID of the user who has created this action. For actions of typeEActionType.SordCreated, this member holds the GUID of Sord.ownerId. For actions of typeEActionType.VersionCreated, this member holds the GUID of DocVersion.ownerId. -
userId
protected int userIdUser ID. It is set to the numerical ID of the user given byuserGuid. This element is read-only. -
userName
User name. It is set to the name of the user given byuserGuid. This element is read-only. -
createDateIso
Create date. This element is the ISO formatted create date of the action. When this object is received fromFeedService.checkoutAction(de.elo.ix.client.ClientInfo, String, ActionZ)orFeedService.findFirstActions(de.elo.ix.client.ClientInfo, FindActionsInfo, int, ActionZ)the value is supplied in the time zone of the client application - which is UTC by default. In case of the object is received by a notify message inFeedNotification.updateAction(Action)the value is relative to the UTC timezone. In order to convert this value into a date object, invoke functionIXConnection.isoToDate(java.lang.String). -
updateDateIso
Update date. This element is only valid forEActionType.UserComment. It holds the ISO formatted update date. When this object is received fromFeedService.checkoutAction(de.elo.ix.client.ClientInfo, String, ActionZ)orFeedService.findFirstActions(de.elo.ix.client.ClientInfo, FindActionsInfo, int, ActionZ)the value is supplied in the time zone of the client application - which is UTC by default. In case of the object is received by a notify message inFeedNotification.updateAction(Action)the value is relative to the UTC timezone. In order to convert this value into a date object, invoke functionIXConnection.isoToDate(java.lang.String).- See Also:
-
changeCounter
protected int changeCounterCounts the number of updates. This element is only valid forEActionType.UserComment. It counts the number of updates made to the comment.- See Also:
-
text
Comment text. This element is only valid forEActionType.UserComment, andEActionType.AutoComment. -
docVersionGuid
GUID of the associated document version. This element is only valid for generated actions that belong to a document version, e.g.EActionType.VersionCreated. Read-only. -
docVersion
Document version object. This element is only valid for generated actions that belong to a document version, e.g.EActionType.VersionCreated. Read-only. -
workflowGuid
GUID of the associated workflow. This element is valid for action types that belong to a workflow. -
workflow
Workflow object. This element is only valid for generated actions that belong to a workflow. Read-only. -
TStamp
Time stamp. Time stamp of creation or modification. -
history
Change history of text member. This list does not contain the current text. This member is null, if the text has not been changed.- Since:
- 9.00.000.033
-
acl
Raw ACL representation. Only valid for Actions of typeEActionType.UserCommentorEActionType.AutoComment. This member is ignored ifaclItemsis not null.- Since:
- 9.00.000.034
- See Also:
-
aclItems
Access control list. Only valid for Actions of typeEActionType.UserCommentorEActionType.AutoComment. This member has precedence beforeacl. Note that no GUID is set for the AND groups of the ACL items.- Since:
- 9.00.000.034
- See Also:
-
TStampSync
Timestamp of this object's last export by the replication.- Since:
- 9.99.009.001
-
-
Constructor Details
-
Action
public Action() -
Action
-
-
Method Details
-
getGuid
-
setGuid
-
getType
-
setType
-
getFeedGuid
-
setFeedGuid
-
getParentGuid
-
setParentGuid
-
getUserGuid
-
setUserGuid
-
getCreateDateIso
-
setCreateDateIso
-
getUpdateDateIso
-
setUpdateDateIso
-
getChangeCounter
public int getChangeCounter() -
setChangeCounter
public void setChangeCounter(int changeCounter) -
getText
-
setText
-
getDocVersionGuid
-
setDocVersionGuid
-
getDocVersion
-
setDocVersion
-
getWorkflowGuid
-
setWorkflowGuid
-
getWorkflow
-
setWorkflow
-
getTStamp
-
setTStamp
-
getUserId
public int getUserId() -
setUserId
public void setUserId(int userId) -
getUserName
-
setUserName
-
getAcl
-
setAcl
-
getAclItems
Note that no GUID is set for the AND groups of the ACL items. -
setAclItems
-
getHistory
-
setHistory
-
getTStampSync
-
setTStampSync
-
toString
-