fuego.papi
Interface ProcessServiceAdminSession

All Superinterfaces:

ProcessServiceSession, Serializable

public interface ProcessServiceAdminSession
extends ProcessServiceSession

ProcessServiceAdminSession contains methods for administering object class instances.

Example:

        // Creates the ProcessService.
        ProcessService processService = ProcessService.create(...);

        // Creates the passport which will connect the user.
        ConnectionPassport passport = processService.createPassport("userId);

        // Sets the password of the user.
        passport.setPassword("userPassport");

        // Fills the passport.
        passport.fillPassport();

        // Creates a new session with the passport and the user's host.
        ProcessServiceSession session = processService.createSession(passport, "userHost");

        ProcessServiceAdminSession adminSession = session.upgradeToAdminSession();
 

Field Summary

static long	serialCheck
static long	serialVersionUID

Method Summary

ObjectClassInstance	objectClassInstanceCreate(String name, String objectClass, String[] assignedRoles, String[] assignedParticipants, String instanceXml) Creates a new ObjectClassInstance with the specified name and object class.
void	objectClassInstanceDelete(ObjectClassInstance instance) Deletes the specified object class instance.
void	objectClassInstanceUpdate(ObjectClassInstance instance) Updates the specified object class instance.

Methods inherited from interface fuego.papi.ProcessServiceSession

abortActivity, activityAbort, activityAbort, activityAbort, activityAbort, activityAbort, activityAbort, activityCommit, activityCommit, activityExecute, activityExecute, activityExecute, activityExecute, activityExecute, activityExecuteApplication, activityExecuteApplication, activityExecuteApplication, activityExecuteApplication, activityGetDocumentation, activityGetDocumentation, activityGetGrabbableInstances, activityGetGrabbableInstances, activityPost, activityPost, activityPost, activityPost, activityPostApplication, activityPostApplication, activityPrepare, activityPrepare, addBookmarks, addHistories, attachmentCheckIn, attachmentCheckIn, attachmentCheckOut, attachmentCheckOutToStream, attachmentCheckOutToStream, attachmentEdit, attachmentEdit, attachmentGet, attachmentGetAllVersions, attachmentGetLastVersion, attachmentRelease, attachmentRelease, attachmentRelease, checkInAttachment, checkOutAttachment, checkOutAttachmentToStream, close, commitExternalActivity, commitExternalActivity, commitExternalActivity, createPresentation, createProcessInstance, createProcessInstance, createView, customRunActivity, customRunActivity, customRunGlobal, customRunGlobalActivity, customRunTask, getActiveProcessId, getActiveProcessIdsByView, getActivityDocumentation, getActivityForView, getAllProcessVersions, getAllProcessVersions, getApplicationsByView, getAttachment, getAttachmentLastVersion, getAttachmentsByInstance, getAttachmentsByView, getAttachmentVersions, getBookmarks, getCalendar, getChildrenViews, getConsult, getConsults, getDefaultPresentation, getDefaultPresentation, getDelegateParticipants, getEditableView, getEscalateParticipants, getGlobalActivities, getGlobalActivities, getGlobalActivities, getGlobalActivities, getGrabActivitiesForInstance, getGrabbableInstances, getHost, getId, getInstance, getInstance, getInstanceByCorrelation, getInstanceData, getInstanceEvents, getInstanceNotes, getInstances, getInstancesByFilter, getInstancesByView, getLocale, getNote, getOrganization, getParentView, getParentViewId, getParticipant, getParticipant, getParticipantsForInstance, getPresentation, getPresentation, getPresentation, getPresentationIds, getProcess, getProcess, getProcessDiagram, getProcessDiagram, getProcessDiagram, getProcessDocumentation, getProcesses, getProcesses, getProcessId, getProcessId, getProcessIds, getProcessIds, getProcessImage, getProcessIn, getProcessService, getSecureEngines, getSessionProperty, getTimeZone, getUserLocale, getUserTimeZone, getVar, getVars, getView, getViewIds, getVisibleActivities, getWorkingAttachments, hasNewInstances, hasNewInstances, instanceAttach, instanceAttach, instanceAttach, instanceAttach, instanceAttach, instanceAttach, instanceCanBeAborted, instanceCanBeAborted, instanceCanBeBack, instanceCanBeDelegate, instanceCanBeDelegated, instanceCanBeDelegated, instanceCanBeEscalate, instanceCanBeEscalated, instanceCanBeEscalated, instanceCanBeProcessed, instanceCanBeProcessed, instanceCanBeReassign, instanceCanBeReassigned, instanceCanBeReassigned, instanceCanBeReassignedToPeer, instanceCanBeReassignedToPeer, instanceCanBeResumed, instanceCanBeResumed, instanceCanBeSelected, instanceCanBeSelected, instanceCanBeSent, instanceCanBeSent, instanceCanBeSentBack, instanceCanBeSentBack, instanceCanBeSuspended, instanceCanBeSuspended, instanceCanBeUngrabbed, instanceCanBeUngrabbed, instanceCanBeUnselected, instanceCanBeUnselected, instanceGetAttachments, instanceGetAttachments, instanceGetData, instanceGetData, instanceGetEvents, instanceGetEvents, instanceGetGlobalActivities, instanceGetGlobalActivities, instanceGetLastConsult, instanceGetLastConsult, instanceGetNotes, instanceGetNotes, instanceGetParticipants, instanceGetParticipants, instanceGetParticipants, instanceGetParticipants, instanceGetProcessId, instanceGetProcessId, instanceGetVariable, instanceGetVariable, instanceGrabbableFrom, instanceGrabbableFrom, instanceHasAttachments, instanceHasAttachments, instanceHasNotes, instanceHasNotes, instanceLinkExternalAttachment, instanceLinkExternalAttachment, instanceReassign, instanceReassign, instanceReassign, instanceRefresh, instanceRefresh, instanceRetrieveProperty, instanceRetrieveProperty, instancesAbort, instancesAbort, instancesAddBookmark, instancesAddConsult, instancesAddConsult, instancesAddHistory, instancesAddNote, instancesAddNote, instancesGetBookmarks, instancesGetConsults, instancesGetParticipants, instancesGetParticipants, instancesGetTargetActivities, instancesGetTargetActivitiesList, instancesGetTargetParticipants, instancesGetTargetParticipantsForActivity, instancesGrab, instancesGrab, instancesReassign, instancesRemoveBookmark, instancesResume, instancesResume, instancesSelect, instancesSelect, instancesSend, instancesSend, instancesSendBack, instancesSendBack, instancesSendTo, instancesSendTo, instancesSendTo, instancesSendTo, instancesSuspend, instancesSuspend, instancesTargetParticipants, instanceStoreProperty, instanceStoreProperty, instancesUngrab, instancesUngrab, instancesUnselect, instancesUnselect, isChangeParticipantPasswordSupported, isOpened, noteGet, objectClassInstanceFetchByName, objectClassInstanceFetchByParticipants, objectClassInstanceFetchByRoles, objectClassInstanceFetchByRolesAndParticipants, obtainEditionLock, organization, organizations, participantCalendar, participantChangePasswordEnabled, participantCurrent, participantEnableMailReception, participantFind, participantFindByName, participantHost, participantLocale, participantRetrieveProperties, participantRetrieveProperty, participantStoreProperties, participantStoreProperty, participantTimeZone, participantUpdateLocale, participantUpdatePassword, participantUpdateTimeZone, prepareExternalActivity, prepareExternalActivity, prepareExternalActivity, presentationCreate, presentationEdit, presentationGet, presentationGet, presentationGet, presentationGetDefault, presentationGetDefault, presentationRefresh, presentationRemove, presentationsGetIds, presentationStore, processCreateInstance, processCreateInstance, processCreateInstance, processCreateInstance, processesGet, processesGet, processesGetAllVersions, processesGetApplications, processesGetGlobalActivities, processesGetGlobalActivities, processesGetGlobalActivities, processesGetIds, processesGetIds, processesGetInstancesByFilter, processGet, processGet, processGetActiveVersion, processGetAllVersions, processGetDiagram, processGetDiagram, processGetDocumentation, processGetId, processGetIn, processGetInstance, processGetInstance, processGetInstanceByCorrelation, processGetInstances, processGetVisibleActivities, processGetWorkingAttachments, processRun, processSendNotification, processSendNotification, putSessionProperty, refresh, releaseEditionLock, releaseEditionLock, removeBookmarks, removePresentation, removeView, retrieveRoleProperties, retrieveUserProperties, retrieveUserStringProperty, roleRetrieveProperties, runActivity, runActivity, runActivity, runActivity, runGlobal, runGlobalActivity, runGlobalActivity, runProcess, searchParticipantsByName, sendNotification, sendNotification, setCanReceiveMail, setDefaultOrderByForViews, setLocale, setTimeZone, storePresentation, storeUserProperties, storeView, taskCanBeProcessed, taskCanBeProcessed, taskCanBeSelected, taskCanBeSelected, taskCanBeUnselected, taskCanBeUnselected, tasksSelect, tasksSelect, tasksSelect, tasksUnselect, tasksUnselect, tasksUnselect, toString, updateSecurityToken, updateUserLocale, updateUserPassword, updateUserTimeZone, upgradeToAdminSession, variableGet, variablesGet, viewCreate, viewEdit, viewGet, viewGetActivity, viewGetApplications, viewGetApplications, viewGetAttachments, viewGetChildren, viewGetInstances, viewGetInstances, viewGetParent, viewGetParent, viewGetParentId, viewHasNewInstances, viewRefresh, viewRemove, viewsGetIds, viewsHaveNewInstances, viewsSetDefaultOrder, viewStore

Field Detail

serialCheck

static final long serialCheck

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

objectClassInstanceCreate

ObjectClassInstance objectClassInstanceCreate(String name,
                                              String objectClass,
                                              String[] assignedRoles,
                                              String[] assignedParticipants,
                                              String instanceXml)
                                              throws OperationException

Creates a new ObjectClassInstance with the specified name and object class. The created object class instance will be associated to the roles and participants defined. It's strongly recommended that the object class name follows the format: [vendor.][application.][module.]name

Parameters:

name - the instance's name.

objectClass - The object class name this instance belongs to.

assignedRoles - the roles' Id this instance is visible to.

assignedParticipants - The participants' Id this instance is visible to.

instanceXml - The serialized instance in xml format.

Returns:

a new ObjectClassInstance object

Throws:

OperationException - if the administration session could not perform the operation

objectClassInstanceUpdate

void objectClassInstanceUpdate(ObjectClassInstance instance)
                               throws OperationException

Updates the specified object class instance.

Parameters:

instance - the object class instance to update

Throws:

OperationException - if the administration session could not perform the operation

objectClassInstanceDelete

void objectClassInstanceDelete(ObjectClassInstance instance)
                               throws OperationException

Deletes the specified object class instance.

Parameters:

instance - the object class instance to delete

Throws:

OperationException - if the administration session could not perform the operation