@Deprecated
public interface MiniMetadataService
extends com.appiancorp.services.ContextSensitiveService
When a user begins to edit a miniwebsite, a draft is created and all changes are made to that draft. When the user wants to make the draft public, he submits it for publishing.
When a miniwebsite is submitted for publishing, it may require the approval of the channel administrator. If it requires approval, then the administrator must approve the draft before the public can see it. If it does not require approval, the public can see it immediately, and it replaces the version that was previously available for the public to see.
All published drafts are kept as a history of the miniwebsite. Each published draft becomes a version in the history.
Note: This service does not write any data to disk. That must be done separately in order to use the service.
When a draft is created, the miniwebsite is locked and no other users may edit the miniwebsite or create a draft unless they break the lock (in which case the first user's draft is deleted). Locking prevents someone from accidentally overwriting someone else's draft.
Methods of service classes can all throw the unchecked exception
ServiceException
if any
system-level error (for example, server failure) occurs, and will in general
throw a checked exception (InvalidXXXException
) when an entity
to be retrieved is inaccessible, instead of returning null
.
Exceptions to this paradigm (including the use of ResultList
as
described below) are noted. All checked exceptions extend
AppianException
.
It may be necessary to retrieve a subset of results as opposed to an entire
collection, and also to sort the subset by some property of the returned
object. "Paging" methods which return a
ResultPage
are provided in certain
instances for this purpose. The ResultPage
will contain the
sorted subset of results
(via Result.getResults()
), and the
total number of items in the available result set
(via ResultPage.getAvailableItems()
).
It may also be necessary to retrieve some results, even if all results
cannot be retrieved (for instance, some of the entities corresponding
to a list of entity IDs may no longer exist). Methods which return a
ResultList
are provided for this
purpose. The Result.getResults()
method in this case will return all results which can be retrieved. In
addition, there will be a list of result codes
(ResultList.getResultCodes()
) that
represent the successful retrieval of an entity, or, if the entity could
not be retrieved, the reason for the failure. See the CODE_XXX
constants in ResultList
for details.
MiniMetadata
,
FileChange
Modifier and Type | Field and Description |
---|---|
static boolean |
breakLock$UPDATES
Deprecated.
|
static boolean |
changeAuthor$UPDATES
Deprecated.
|
static boolean |
changeMiniApproval$UPDATES
Deprecated.
|
static boolean |
changeMwsPath$UPDATES
Deprecated.
|
static boolean |
createMini$UPDATES
Deprecated.
|
static boolean |
deleteDraftMini$UPDATES
Deprecated.
|
static boolean |
editMini$UPDATES
Deprecated.
|
static boolean |
getAllMiniFilenamesPaging$UPDATES
Deprecated.
|
static boolean |
getApplicationName$UPDATES
Deprecated.
|
static boolean |
getMiniApproval$UPDATES
Deprecated.
|
static boolean |
getRevisionHistory$UPDATES
Deprecated.
|
static boolean |
getWorkspace$UPDATES
Deprecated.
|
static boolean |
promoteToDraft$UPDATES
Deprecated.
|
static boolean |
publishSubmitted$UPDATES
Deprecated.
|
static boolean |
rejectSubmitted$UPDATES
Deprecated.
|
static boolean |
returnSubmitted$UPDATES
Deprecated.
|
static boolean |
saveDraft$UPDATES
Deprecated.
|
static boolean |
submitDraft$UPDATES
Deprecated.
|
static boolean |
uneditMini$UPDATES
Deprecated.
|
static boolean |
unsubmit$UPDATES
Deprecated.
|
static boolean |
viewCurrentMini$UPDATES
Deprecated.
|
static boolean |
viewMini$UPDATES
Deprecated.
|
static boolean |
viewUnpublishedMinis$UPDATES
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
breakLock(java.lang.Long portletId_)
Deprecated.
Break the lock on a given miniwebsite portlet.
|
void |
changeAuthor(java.lang.Long portletId_,
java.lang.String oldAuthor_,
java.lang.String newAuthor_)
Deprecated.
Change the author of a draft/submission of a given miniwebsite portlet.
|
void |
changeMiniApproval(java.lang.Long portletId_,
boolean approvalRequired_)
Deprecated.
Set whether or not changes to a given miniwebsite portlet will require
approval by the channel administrator.
|
void |
changeMwsPath(java.lang.String substring_,
java.lang.String replacement_)
Deprecated.
Modify the path where mini website content is stored for existing mini
websites.
|
void |
createMini(java.lang.Long portletId_,
java.lang.String template_,
boolean isVersioned_,
boolean requiresApproval_)
Deprecated.
Create a new miniwebsite portlet or a new version of an existing
miniwebsite portlet.
|
java.lang.String |
deleteDraftMini(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Delete an author's current draft for a given miniwebsite portlet.
|
MiniMetadata |
editMini(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Lock a given miniwebsite portlet in order to edit it.
|
ResultPage |
getAllMiniFilenamesPaging(int startPosition_,
int batchSize_)
Deprecated.
Gets the
filename paths of all version (including prior) and drafts for all valid
MiniWebSites
|
java.lang.String |
getApplicationName()
Deprecated.
Gets the name of the application on which this service is running.
|
boolean |
getMiniApproval(java.lang.Long portletId_)
Deprecated.
Returns whether changes to a given miniwebsite portlet require approval
by the channel administrator.
|
MiniMetadata[] |
getRevisionHistory(java.lang.Long portletId_)
Deprecated.
Get the revision history for a given miniwebsite portlet.
|
java.lang.String[] |
getWorkspace()
Deprecated.
Gets the current memory profile for the workspace.
|
FileChange |
promoteToDraft(java.lang.Long portletId_,
java.lang.Integer versionId_,
java.lang.String author_)
Deprecated.
Use a version of a given miniwebsite portlet to create a draft for a
new version of the miniwebsite.
|
FileChange |
publishSubmitted(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Publish an author's submitted draft for a given miniwebsite portlet.
|
java.lang.String |
rejectSubmitted(java.lang.Long portletId_,
java.lang.String author_,
java.lang.String message_)
Deprecated.
Reject an author's miniwebsite draft submission.
|
void |
returnSubmitted(java.lang.Long portletId_,
java.lang.String author_,
java.lang.String message_)
Deprecated.
Return an author's miniwebsite draft submission for rework.
|
java.lang.String |
saveDraft(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Save an author's current draft for a given miniwebsite portlet.
|
void |
submitDraft(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Submit an author's current miniwebsite draft for approval.
|
void |
uneditMini(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Unlock a given miniwebsite portlet if it is currently locked by the
passed author and the author has no drafts/submissions.
|
void |
unsubmit(java.lang.Long portletId_,
java.lang.String author_)
Deprecated.
Cancel the submission for approval of a miniwebsite draft.
|
MiniMetadata |
viewCurrentMini(java.lang.Long portletId_)
Deprecated.
Get information about the latest version of a given miniwebsite portlet.
|
MiniMetadata |
viewMini(java.lang.Long portletId_,
java.lang.Integer revisionId_)
Deprecated.
View a version of a given miniwebsite portlet.
|
MiniMetadata[] |
viewUnpublishedMinis(java.lang.Long portletId_)
Deprecated.
View the unpublished versions of a given miniwebsite portlet.
|
static final boolean createMini$UPDATES
static final boolean editMini$UPDATES
static final boolean uneditMini$UPDATES
static final boolean viewUnpublishedMinis$UPDATES
static final boolean changeAuthor$UPDATES
static final boolean deleteDraftMini$UPDATES
static final boolean saveDraft$UPDATES
static final boolean submitDraft$UPDATES
static final boolean unsubmit$UPDATES
static final boolean publishSubmitted$UPDATES
static final boolean returnSubmitted$UPDATES
static final boolean rejectSubmitted$UPDATES
static final boolean breakLock$UPDATES
static final boolean getRevisionHistory$UPDATES
static final boolean viewMini$UPDATES
static final boolean promoteToDraft$UPDATES
static final boolean getMiniApproval$UPDATES
static final boolean changeMiniApproval$UPDATES
static final boolean viewCurrentMini$UPDATES
static final boolean changeMwsPath$UPDATES
static final boolean getApplicationName$UPDATES
static final boolean getWorkspace$UPDATES
static final boolean getAllMiniFilenamesPaging$UPDATES
void createMini(java.lang.Long portletId_, java.lang.String template_, boolean isVersioned_, boolean requiresApproval_) throws java.lang.IllegalArgumentException, InvalidPortletException, InvalidPortletTypeException
portletId_
- The ID of a miniwebsite portlet, if creating a new
version of an existing portlettemplate_
- reserved for future use; should be set to null
.
Value is saved to the database but not used anywhere.isVersioned_
- Set to true
to enable versioning for
the miniwebsite (all revisions of the portlet will be saved).
Set to false
if new versions of the portlet should replace
any existing versions.requiresApproval_
- Sets whether the changes to this miniwebsite
portlet will require approval by the channel administratorsjava.lang.IllegalArgumentException
- if the portlet ID corresponds to a
non-miniwebsite portletInvalidPortletException
- if the portlet ID is null or no portlet
with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type does
not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursMiniMetadata editMini(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletException
author_
will be able to edit the portlet while it is
locked. If the miniwebsite is already locked, the MiniMetadata returned
will show who locked the miniwebsite and the lock will not be broken.portletId_
- The ID of the miniwebsite portlet
that should be locked.author_
- The username of the author who will edit the portlet.MiniMetadata
object containing information
about the miniwebsite portlet whose ID was passed or null if
the portlet ID corresponds to a non-miniwebsite portletInvalidPortletException
- if the portlet ID is null
or no portlet with the passed ID existsServiceException
- if any system-level error occursjava.lang.IllegalArgumentException
void uneditMini(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletException, InvalidPortletTypeException
portletId_
- The ID of the miniwebsite portlet
that should be unlocked.author_
- The username of the author calling this functionjava.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type does
not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursMiniMetadata[] viewUnpublishedMinis(java.lang.Long portletId_) throws java.lang.IllegalArgumentException, InvalidPortletException, InvalidPortletTypeException
portletId_
- The ID of a miniwebsite portlet.MiniMetadata
objects containing
information about each of the unpublished versions of the portlet.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursvoid changeAuthor(java.lang.Long portletId_, java.lang.String oldAuthor_, java.lang.String newAuthor_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.oldAuthor_
- The username of the author of the miniwebsite
draft/submission.newAuthor_
- The username of the person who should be set as the
author of the minwebsite draft/submission.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursjava.lang.String deleteDraftMini(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author whose draft should be deleted.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursjava.lang.String saveDraft(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author whose draft should be saved.java.lang.IllegalArgumentException
- if the portlet ID corresponds to a non-miniwebsite portletInvalidPortletException
- if portlet ID is null
or no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursvoid submitDraft(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author submitting the draft.java.lang.IllegalArgumentException
- if the portlet ID corresponds to a non-miniwebsite portletInvalidPortletException
- if the portlet ID is null
or no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursvoid unsubmit(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author of the submitted draft.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursFileChange publishSubmitted(java.lang.Long portletId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author who submitted the draft.FileChange
object containing: 1) the path to the
file containing the submitted draft's body 2) the path to the file
where the new version for the miniwebsite should be created.
The body of the submitted draft should then be copied into the file for
the new miniwebsite version, and the draft file should be deleted.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursvoid returnSubmitted(java.lang.Long portletId_, java.lang.String author_, java.lang.String message_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author of the submitted draft.message_
- Return message text. This parameter reserved for future
use, and should be set to null
.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursjava.lang.String rejectSubmitted(java.lang.Long portletId_, java.lang.String author_, java.lang.String message_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.author_
- The username of the author of the submitted draft.message_
- Rejection message text. This parameter is reserved for
future use, and should be set to null
.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursjava.lang.String breakLock(java.lang.Long portletId_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a locked miniwebsite portlet.java.lang.IllegalArgumentException
- if the portlet ID corresponds to a non-miniwebsite portletInvalidPortletException
- if portlet ID is null
or no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursMiniMetadata[] getRevisionHistory(java.lang.Long portletId_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.MiniMetadata
objects containing
information about each of the revisions of the miniwebsite.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursMiniMetadata viewMini(java.lang.Long portletId_, java.lang.Integer revisionId_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.revisionId_
- The ID of the miniwebsite version to retrieve.MiniMetadata
object containing information
about the requested miniwebsite version.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursFileChange promoteToDraft(java.lang.Long portletId_, java.lang.Integer versionId_, java.lang.String author_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.versionId_
- The ID of the miniwebsite version to retrieve.author_
- The username of the author of that miniwebsite version.FileChange
object containing: 1) the path to the
file containing the requested miniwebsite version's body 2) the path to
the file where the body of the new draft for the miniwebsite should be
created. The body of the retrieved miniwebsite version should then be
copied into the file for the new draft.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursboolean getMiniApproval(java.lang.Long portletId_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.true
if changes to the miniwebsite require approval
and false
otherwise.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursvoid changeMiniApproval(java.lang.Long portletId_, boolean approvalRequired_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.approvalRequired_
- Set to true
if changes to the
miniwebsite should require approval and false
otherwise.java.lang.IllegalArgumentException
- if the portlet ID is null
or corresponds to a non-miniwebsite portletInvalidPortletException
- if no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursMiniMetadata viewCurrentMini(java.lang.Long portletId_) throws java.lang.IllegalArgumentException, InvalidPortletTypeException, InvalidPortletException
portletId_
- The ID of a miniwebsite portlet.MiniMetadata
object containing information
about the latest miniwebsite version.java.lang.IllegalArgumentException
- if the portlet ID corresponds to a non-miniwebsite portletInvalidPortletException
- if portlet ID is null or no portlet with the passed ID existsInvalidPortletTypeException
- if the miniwebsite portlet type
does not exist (for example, if the type was never registered)ServiceException
- if any system-level error occursvoid changeMwsPath(java.lang.String substring_, java.lang.String replacement_)
substring_
and the new
directory path as the replacement_
.substring_
- A substring of the path, every occurence of
which should be replaced.replacement_
- The string with which every occurence of
substring_
should be replaced for all existing mini
websites.ServiceException
- if any system-level error occursjava.lang.String getApplicationName()
ServiceException
- if any system-level error occursjava.lang.String[] getWorkspace()
ServiceException
- if any system-level error occursResultPage getAllMiniFilenamesPaging(int startPosition_, int batchSize_) throws PrivilegeException
startPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.PrivilegeException
- if user does not have permissions to make this
callServiceException
- if any system-level error occursCopyright © 2003-2024 Appian Corporation. All Rights Reserved.