com.appiancorp.suiteapi.content

Class Approval

java.lang.Object

com.appiancorp.suiteapi.content.Approval

public class Approval
extends java.lang.Object

The approval bean contains the approval status for a list of content items.

Constructor Summary

Constructors

Constructor and Description
Approval()

Method Summary

Modifier and Type	Method and Description
java.lang.Long[]	getApproverGroups() Get the explicit groups that could approve, not including implicit App Admins.
java.lang.String[]	getApproverUsers() Get the explicit users that could approve, not including implicit App Admins.
java.lang.Long[]	getId() Get the content ids that were acted upon (this is the full list of ids that were acted upon, while other methods such as getPendingId() return the appropriate subsets of this list).
java.lang.Long[]	getPendingId() Get the ids that were not fully acted upon, and as such are in a pending state (pending creation approval, deletion approval, etc.).
java.lang.Long[]	getPendingLogId() Get the log ids of those pending (the log ids being KC ids where applicable).
java.lang.String[]	getPendingName() Get the names of the pending content items.
void	setApproverGroups(java.lang.Long[] approverGroups_) Set the groups that can approve.
void	setApproverUsers(java.lang.String[] approverUsers_) Set the users that can approve.
void	setId(java.lang.Long[] ids_) Set the content ids that were acted upon (created, deleted, etc).
void	setPendingId(java.lang.Long[] pendingIds_) Set the ids that were not fully acted upon, and as such are in a pending state (pending creation approval, deletion approval, etc.).
void	setPendingLogId(java.lang.Long[] pendingLogIds_) Get the log ids of those pending (the log ids being KC ids where applicable).
void	setPendingName(java.lang.String[] pendingNames_) Set the names of the pending content items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Approval

public Approval()

Method Detail

getApproverGroups

public java.lang.Long[] getApproverGroups()

Get the explicit groups that could approve, not including implicit App Admins. This is most commonly used for notifications.

Returns:

the ids of the approver groups

See Also:

setApproverGroups(Long[])

setApproverGroups

public void setApproverGroups(java.lang.Long[] approverGroups_)

Set the groups that can approve.

Parameters:

approverGroups_ - ids of the approver groups

See Also:

getApproverGroups()

getApproverUsers

public java.lang.String[] getApproverUsers()

Get the explicit users that could approve, not including implicit App Admins. This is most commonly used for notifications.

Returns:

usernames of the approvers

See Also:

setApproverUsers(String[])

setApproverUsers

public void setApproverUsers(java.lang.String[] approverUsers_)

Set the users that can approve.

Parameters:

approverUsers_ - usernames of the approvers

See Also:

getApproverUsers()

getId

public java.lang.Long[] getId()

Get the content ids that were acted upon (this is the full list of ids that were acted upon, while other methods such as getPendingId() return the appropriate subsets of this list).

Returns:

list of content ids

See Also:

setId(Long[])

setId

public void setId(java.lang.Long[] ids_)

Set the content ids that were acted upon (created, deleted, etc).

Parameters:

ids_ - list of content ids

See Also:

getId()

getPendingId

public java.lang.Long[] getPendingId()

Get the ids that were not fully acted upon, and as such are in a pending state (pending creation approval, deletion approval, etc.).

Returns:

list of pending content ids

See Also:

setPendingId(Long[])

setPendingId

public void setPendingId(java.lang.Long[] pendingIds_)

Set the ids that were not fully acted upon, and as such are in a pending state (pending creation approval, deletion approval, etc.).

Parameters:

pendingIds_ - list of content ids

See Also:

getPendingId()

getPendingLogId

public java.lang.Long[] getPendingLogId()

Get the log ids of those pending (the log ids being KC ids where applicable).

Returns:

log ids

See Also:

setPendingLogId(Long[])

setPendingLogId

public void setPendingLogId(java.lang.Long[] pendingLogIds_)

Get the log ids of those pending (the log ids being KC ids where applicable).

Parameters:

pendingLogIds_ - log ids

See Also:

getPendingLogId()

getPendingName

public java.lang.String[] getPendingName()

Get the names of the pending content items.

Returns:

names of pending content items

See Also:

setPendingName(String[])

setPendingName

public void setPendingName(java.lang.String[] pendingNames_)

Set the names of the pending content items.

Parameters:

pendingNames_ - content names

See Also:

getPendingName()