public interface ProfileEntryBatchForm extends ProfileEntryForm
This is the form for creating and updating profile entries in bulk.
Like all OsidForm
objects, various data
elements may be set here for use in the create and update methods in the
ProfileEntryBatchAdminSession.
For each data element that
may be set, metadata may be examined to provide display hints or data
constraints.
Modifier and Type | Method and Description |
---|---|
Id |
getAgentId()
Gets the
Agent Id of the profile entry
if this is a create transaction using an agent. |
Id |
getProfileEntryId()
Gets the
Id of the profile entry to be updated if this
is an update transaction. |
Id |
getProfileItemId()
Gets the work
Id of the profile item if this is a
create transaction. |
Id |
getResourceId()
Gets the
Resource Id of the profile
entry if this is a create transaction using a resource. |
boolean |
hasAgent()
Tests if the create request specified an agent.
|
boolean |
hasResource()
Tests if the create request specified a resource.
|
getProfileEntryFormRecord
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
boolean hasAgent()
true
if an agent is available, false
otherwiseIllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getAgentId()
Agent
Id
of the profile entry
if this is a create transaction using an agent. Id
IllegalStateException
- isForUpdate()
is
true
or hasAgent()
is
false
mandatory
- This method must be implemented. boolean hasResource()
true
if a resource is available, false
otherwiseIllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getResourceId()
Resource
Id
of the profile
entry if this is a create transaction using a resource. Id
IllegalStateException
- isForUpdate()
is
true
or hasResource()
is
false
mandatory
- This method must be implemented. Id getProfileItemId()
Id
of the profile item if this is a
create transaction. Id
IllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getProfileEntryId()
Id
of the profile entry to be updated if this
is an update transaction. Id
IllegalStateException
- isForUpdate()
is
false
mandatory
- This method must be implemented.