public interface JobConstrainerEnablerAdminSession extends OsidSession
This session creates and removes job constrainer enablers. The data for
create and update is provided via the JobConstrainerEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasJobConstrainerEnabler(Id jobConstrainerEnablerId,
Id aliasId)
Adds an
Id to a JobConstrainerEnabler
for the purpose of creating compatibility. |
boolean |
canCreateJobConstrainerEnabler()
Tests if this user can create job constrainer enablers.
|
boolean |
canCreateJobConstrainerEnablerWithRecordTypes(Type[] jobConstrainerEnablerRecordTypes)
Tests if this user can create a single
JobConstrainerEnabler
using the desired record types. |
boolean |
canDeleteJobConstrainerEnablers()
Tests if this user can delete job constrainer enablers.
|
boolean |
canManageJobConstrainerEnablerAliases()
Tests if this user can manage
Id aliases for job
constrainer enablers. |
boolean |
canUpdateJobConstrainerEnablers()
Tests if this user can update job constrainer enablers.
|
JobConstrainerEnabler |
createJobConstrainerEnabler(JobConstrainerEnablerForm jobConstrainerEnablerForm)
Creates a new
JobConstrainerEnabler. |
void |
deleteJobConstrainerEnabler(Id jobConstrainerEnablerId)
Deletes a
JobConstrainerEnabler. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobConstrainerEnablerForm |
getJobConstrainerEnablerFormForCreate(Type[] jobConstrainerEnablerRecordTypes)
Gets the job constrainer enabler form for creating new job constrainer
enablers.
|
JobConstrainerEnablerForm |
getJobConstrainerEnablerFormForUpdate(Id jobConstrainerEnablerId)
Gets the job constrainer enabler form for updating an existing job
constrainer enabler.
|
void |
updateJobConstrainerEnabler(JobConstrainerEnablerForm jobConstrainerEnablerForm)
Updates an existing job constrainer enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateJobConstrainerEnabler()
JobConstrainerEnabler
will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer create operations to
an unauthorized user. false
if JobConstrainerEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateJobConstrainerEnablerWithRecordTypes(Type[] jobConstrainerEnablerRecordTypes)
JobConstrainerEnabler
using the desired record types. While
ResourcingRulesManager.getJobConstrainerEnablerRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
JobConstrainerEnabler.
Providing an empty array tests if a
JobConstrainerEnabler
can be created with no records.jobConstrainerEnablerRecordTypes
- array of job constrainer
enabler record types true
if JobConstrainerEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
jobConstrainerEnablerRecordTypes
is null
mandatory
- This method must be implemented. JobConstrainerEnablerForm getJobConstrainerEnablerFormForCreate(Type[] jobConstrainerEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
jobConstrainerEnablerRecordTypes
- array of job constrainer
enabler record typesNullArgumentException
-
jobConstrainerEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form with
requested record typesmandatory
- This method must be implemented. JobConstrainerEnabler createJobConstrainerEnabler(JobConstrainerEnablerForm jobConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
JobConstrainerEnabler.
jobConstrainerEnablerForm
- the form for this
JobConstrainerEnabler
JobConstrainerEnabler
IllegalStateException
-
jobConstrainerEnablerForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
jobConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobConstrainerEnablerForm
did not originate from
getJobConstrainerEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateJobConstrainerEnablers()
JobConstrainerEnabler
will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer update
operations to an unauthorized user. false
if JobConstrainerEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. JobConstrainerEnablerForm getJobConstrainerEnablerFormForUpdate(Id jobConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobConstrainerEnablerId
- the Id
of the
JobConstrainerEnabler
NotFoundException
- jobConstrainerEnablerId
is not foundNullArgumentException
- jobConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateJobConstrainerEnabler(JobConstrainerEnablerForm jobConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
jobConstrainerEnablerForm
- the form containing the elements to
be updatedIllegalStateException
-
jobConstrainerEnablerForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
jobConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobConstrainerEnablerForm
did not originate from
getJobConstrainerEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteJobConstrainerEnablers()
JobConstrainerEnabler
will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer delete
operations to an unauthorized user. false
if JobConstrainerEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteJobConstrainerEnabler(Id jobConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainerEnabler.
jobConstrainerEnablerId
- the Id
of the
JobConstrainerEnabler
to removeNotFoundException
- jobConstrainerEnablerId
not foundNullArgumentException
- jobConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageJobConstrainerEnablerAliases()
Id
aliases for job
constrainer enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if JobConstrainerEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasJobConstrainerEnabler(Id jobConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a JobConstrainerEnabler
for the purpose of creating compatibility. The primary Id
of the JobConstrainerEnabler
is determined by
the provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another job
constrainer enabler. it is reassigned to the given job constrainer
enabler Id.
jobConstrainerEnablerId
- the Id
of a
JobConstrainerEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- jobConstrainerEnablerId
not foundNullArgumentException
- jobConstrainerEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.