public interface IDfPackage extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
int |
appendNote(java.lang.String text,
boolean persistent)
Adds a note to a package.
|
void |
appendNoteEx(IDfId annotationId,
boolean persistent)
Adds a note to a package.
|
IDfTime |
getAcceptanceDate()
Returns the acceptance date, which identifies when a package arrived and was
accepted by an input port.
|
int |
getActSeqno()
Returns the sequence number (r_act_seqno) of the activity in which the package
is being handled.
|
IDfId |
getComponentChronId(int index)
Returns the component chronical id of one of the bound objects.
|
int |
getComponentChronIdCount()
Returns the number of bound objects in this package.
|
IDfId |
getComponentId(int index)
Returns the component id of one of the bound objects.
|
int |
getComponentIdCount()
Returns the number of bound objects in this package.
|
java.lang.String |
getComponentName(int index)
Returns the component name, which is typically the object name
of the object identified at the corresponding index position
in r_component_id
|
IDfId |
getExecMethodId()
Retrieves the method id of the corresponding workflow object.
|
int |
getNoteCount()
Returns the number of notes in this package.
|
IDfTime |
getNoteCreationDate(int noteIndex)
Returns an IDfTime interface which contains the creation date of the specified note.
|
int |
getNoteFlag(int noteIndex)
Returns the special flags for a note.
|
IDfId |
getNoteId(int noteIndex)
Returns the object id of the dm_note object.
|
boolean |
getNotePersistance(int noteIndex)
Returns a boolean value to indicate whether the note is persistent across
all activities.
|
java.lang.String |
getNoteText(int noteIndex)
Returns a String containing the content of the specified note.
|
java.lang.String |
getNoteWriter(int noteIndex)
Returns the name of the user who wrote the note.
|
int |
getPackageCount()
Returns the package count of a collection package.
|
int |
getPackageFlag()
Returns the package flag for the package (if it exists).
|
IDfId |
getPackageId(int index)
Rerturns the id of a package in a collection package.
|
java.lang.String |
getPackageLabel(int index)
Returns the version label for the package (if it exists).
|
java.lang.String |
getPackageName()
Returns the package name.
|
java.lang.String |
getPackageOperation()
Returns the package operation, which is copied from the package definition upon
creation of a package.
|
int |
getPackageOrder()
Returns the order number, which identifies where a package definition appears in the
containing port definition.
|
java.lang.String |
getPackageType()
Returns the package type, which is the type name of the bound components.
|
java.lang.String |
getPortName()
Returns the name of the port of the activity runtime instance in which the
package is being handled.
|
IDfId |
getWorkflowId()
Returns the workflow id.
|
boolean |
isManufactured()
This method returns
true if this is a package that was
manually created by the user and did not come in on an INPUT port. |
void |
removeNote(int noteIndex)
Removes an existing note from a package.
|
void |
removeNoteEx(IDfId annotationId)
Removes an existing note from a package.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
int appendNote(java.lang.String text, boolean persistent) throws DfException
text
argument. The object is stored in the repository folder
/Resources/user_name where user_name is the current user.
The method then sets the r_note_id attribute of the package object to the object ID
of the dm_note object.
The persistent
flag determines whether the note is sent only to the
performer of the next activity or to the performers of all subsequent activities.text
- text of the note to addpersistent
- true
to send the note to all remaining participants,
false
to send the note only to the next participant.DfException
- if a server error occursvoid appendNoteEx(IDfId annotationId, boolean persistent) throws DfException
persistent
flag determines whether the note is sent only to the
performer of the next activity or to the performers of all subsequent activities.annotationId
- id of the note object to addpersistent
- true
to send the note to all remaining participants,
false
to send the note only to the next participant.DfException
- if a server error occursvoid removeNote(int noteIndex) throws DfException
The method detaches the note with the package, but it does not destroy the note itself.
Only the user who added the note to a package can remove the note from the package.
noteIndex
- the index of the note you want to remove from the package.DfException
- if a server error occursgetNoteCount()
void removeNoteEx(IDfId annotationId) throws DfException
The method detaches the note with the package, but it does not destroy the note itself.
Only the user who added the note to a package can remove the note from the package.
annotationId
- the id of the note object you want to remove from the package.DfException
- if a server error occursgetNoteCount()
IDfId getExecMethodId() throws DfException
DfException
- if a server error occursboolean getNotePersistance(int noteIndex) throws DfException
false
means that a note is only visible to
performers of the immediately following activities.noteIndex
- the index of the note in the packagetrue
if the note is persistent; false
otherwiseDfException
- if a server error occursgetNoteCount()
java.lang.String getNoteText(int noteIndex) throws DfException
noteIndex
- the index of the note in the packageDfException
- if a server error occursgetNoteCount()
IDfTime getNoteCreationDate(int noteIndex) throws DfException
noteIndex
- the index of the note in the packageDfException
- if a server error occursgetNoteCount()
IDfId getWorkflowId() throws DfException
DfException
- if a server error occursint getActSeqno() throws DfException
DfException
- if a server error occursjava.lang.String getPortName() throws DfException
DfException
- if a server error occursjava.lang.String getPackageName() throws DfException
DfException
- if a server error occursjava.lang.String getPackageType() throws DfException
DfException
- if a server error occursint getPackageOrder() throws DfException
DfException
- if a server error occursjava.lang.String getPackageOperation() throws DfException
DfException
- if a server error occursIDfTime getAcceptanceDate() throws DfException
DfException
- if a server error occursIDfId getComponentId(int index) throws DfException
index
- the index of the bound objectDfException
- if a server error occursgetComponentIdCount()
int getComponentIdCount() throws DfException
DfException
- if a server error occursgetComponentId(int)
IDfId getComponentChronId(int index) throws DfException
index
- the index of the bound objectDfException
- if a server error occursgetComponentChronIdCount()
int getComponentChronIdCount() throws DfException
DfException
- if a server error occursgetComponentChronId(int)
int getNoteCount() throws DfException
DfException
- if a server error occursgetNoteText(int)
,
getNotePersistance(int)
,
removeNote(int)
,
getNoteCreationDate(int)
,
getNoteWriter(int)
,
getNoteId(int)
,
getNoteFlag(int)
java.lang.String getNoteWriter(int noteIndex) throws DfException
noteIndex
- the index of the note in the packageDfException
- if a server error occursgetNoteCount()
IDfId getNoteId(int noteIndex) throws DfException
noteIndex
- the index of the note in the packageDfException
- if a server error occursgetNoteCount()
int getNoteFlag(int noteIndex) throws DfException
A package carries some notes from one activity to another. It drops old notes (those added by previous activity performers) and carries only new notes (those added by the current activity performers) to the next activity. Turning on the keep flag of r_note_flag, however, changes this behavior and allows a note to be carried further down the stream. Such a note remains attached, until its keep flag gets turned off or the attached package is dropped.
bit 1: keep flag bit 2: old (OFF) versus new note (ON)
noteIndex
- the index of the note in the packageDfException
- if a server error occursgetNoteCount()
int getPackageCount() throws DfException
At runtime, packages are delivered from one activity to the other through ports. A package can be either of the following forms:
Single: a package that is bound with only one object. Collection: a package that is bound with a set of objects. A package with multiple bound objects is typically the result of a DQL query.
DfException
- if a server error occursjava.lang.String getPackageLabel(int index) throws DfException
index
- the index of the package labelDfException
- if a server error occursIDfId getPackageId(int index) throws DfException
Single: a package that is bound with only one object. Collection: a package that is bound with a set of objects. A collection package is typically the result of a DQL query.
index
- the index of the package in the collectionDfException
- if a server error occursgetPackageCount()
boolean isManufactured() throws DfException
true
if this is a package that was
manually created by the user and did not come in on an INPUT port.true
if this is a package that was manually
created by the user; false
otherwise.DfException
- if a server error occurs.java.lang.String getComponentName(int index) throws DfException
DfException
int getPackageFlag() throws DfException
DfException
- if a server error occursCopyright 1994-2023 OpenText Corporation. All rights reserved.