Package org.cyclos.entities.system

Class CustomOperation

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.ConfigurationEntity

org.cyclos.entities.ConfigurationOrderableEntity

org.cyclos.entities.system.CustomOperation

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasContentScript, HasNetwork, HasOrder, HasSvgIcon, ProcessableForProxying, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity, UsesScript

@Entity
public class CustomOperation
extends ConfigurationOrderableEntity
implements HasSvgIcon, DefinesNetwork, HasContentScript

A custom operation which may be triggered by users

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Constructor Summary

Constructors

Constructor	Description
CustomOperation()

Method Summary

Modifier and Type	Method	Description
Set<CustomOperationAction>	getActions()
AdminMainMenu	getAdminMenu()
Set<Channel>	getChannels()
Integer	getCloseAfterSeconds()
String	getConfirmationText()
CustomScript	getContentScript()
String	getContentScriptParameters()
String	getCustomSubmitLabel()
DataTranslationType	getDataTranslationType()	If this entity allows data translation, should return the translation type
List<CustomOperationField>	getFormParameters()
FrontendMenu	getFrontendMenu()
String	getIcon()
String	getInformationText()
String	getLabel()
Network	getNetwork()	Returns the network this entity belongs to
ProfileManagementSection	getProfileSection()
Set<RecordType>	getRecordTypes()
String	getResultInformationText()	Information text only valid for custom operation of type CustomOperationResultType.RESULT_PAGE marked to run in channels other than BuiltInChannel.MAIN.
CustomOperationResultType	getResultType()
CustomOperationResultPageRowAction	getRowAction()
Location	getRowLocation()
CustomOperation	getRowOperation()
List<String>	getRowParameters()
String	getRowUrl()
CustomOperationScope	getScope()
CustomScript	getScript()
String	getScriptParameters()
CustomScriptUsedInType	getScriptUsedInType()	Returns the type of script usage
CustomOperationShowForm	getShowForm()
String	getSvgIcon()
Set<TransferType>	getTransferTypes()
UserMainMenu	getUserMenu()
boolean	isAllowExport()
boolean	isAllowPrint()
boolean	isEnabled()	Indicates whether this entity is enabled
boolean	isEnabledForActiveUsers()
boolean	isEnabledForPendingUsers()
boolean	isHasFileUpload()
boolean	isOpenRowInNewWindow()
boolean	isRequireConfirmationCredential()
boolean	isSearchAutomatically()
boolean	isSubmitWithQrCodeScan()
void	setActions(Set<CustomOperationAction> actions)
void	setAdminMenu(AdminMainMenu adminMenu)
void	setAllowExport(boolean allowExport)
void	setAllowPrint(boolean allowPrint)
void	setChannels(Set<Channel> channels)
void	setCloseAfterSeconds(Integer closeAfterSeconds)
void	setConfirmationText(String confirmationText)
void	setContentScript(CustomScript contentScript)
void	setContentScriptParameters(String contentScriptParameters)
void	setCustomSubmitLabel(String customSubmitLabel)
void	setEnabledForActiveUsers(boolean enabledForActiveUsers)
void	setEnabledForPendingUsers(boolean enabledForPendingUsers)
void	setFrontendMenu(FrontendMenu frontendMenu)
void	setHasFileUpload(boolean hasFileUpload)
void	setIcon(String icon)
void	setInformationText(String informationText)
void	setLabel(String label)
void	setNetwork(Network network)
void	setOpenRowInNewWindow(boolean openRowInNewWindow)
void	setProfileSection(ProfileManagementSection profileSection)
void	setRecordTypes(Set<RecordType> recordTypes)
void	setRequireConfirmationCredential(boolean requireConfirmationCredential)
void	setResultInformationText(String resultInformationText)
void	setResultType(CustomOperationResultType resultType)
void	setRowLocation(Location rowLocation)
void	setRowOperation(CustomOperation rowOperation)
void	setRowParameters(List<String> params)
void	setRowUrl(String rowUrl)
void	setScope(CustomOperationScope scope)
void	setScript(CustomScript script)
void	setScriptParameters(String scriptParameters)
void	setSearchAutomatically(boolean searchAutomatically)
void	setShowForm(CustomOperationShowForm showForm)
void	setSubmitWithQrCodeScan(boolean submitWithQrCodeScan)
void	setSvgIcon(String svgIcon)
void	setTransferTypes(Set<TransferType> transferTypes)
void	setUserMenu(UserMainMenu userMenu)

Methods inherited from class org.cyclos.entities.ConfigurationOrderableEntity

compareTo, getOrder, setOrder, toString

Methods inherited from class org.cyclos.entities.ConfigurationEntity

getDescription, getInternalName, setDescription, setInternalName, toShortString

Methods inherited from class org.cyclos.entities.NamedEntity

getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity

getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Constructor Detail

CustomOperation

public CustomOperation()

Method Detail

getActions

public Set<CustomOperationAction> getActions()

getAdminMenu

public AdminMainMenu getAdminMenu()

getChannels

public Set<Channel> getChannels()

getCloseAfterSeconds

public Integer getCloseAfterSeconds()

getConfirmationText

public String getConfirmationText()

getContentScript

public CustomScript getContentScript()

Specified by:

getContentScript in interface HasContentScript

getContentScriptParameters

public String getContentScriptParameters()

Specified by:

getContentScriptParameters in interface HasContentScript

getCustomSubmitLabel

public String getCustomSubmitLabel()

getDataTranslationType

public DataTranslationType getDataTranslationType()

Description copied from class: BaseEntity

If this entity allows data translation, should return the translation type

Overrides:

getDataTranslationType in class BaseEntity

getFormParameters

public List<CustomOperationField> getFormParameters()

getFrontendMenu

public FrontendMenu getFrontendMenu()

getIcon

public String getIcon()

getInformationText

public String getInformationText()

getLabel

public String getLabel()

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getProfileSection

public ProfileManagementSection getProfileSection()

getRecordTypes

public Set<RecordType> getRecordTypes()

getResultInformationText

public String getResultInformationText()

Information text only valid for custom operation of type CustomOperationResultType.RESULT_PAGE marked to run in channels other than BuiltInChannel.MAIN.

getResultType

public CustomOperationResultType getResultType()

getRowAction

public CustomOperationResultPageRowAction getRowAction()

getRowLocation

public Location getRowLocation()

getRowOperation

public CustomOperation getRowOperation()

getRowParameters

public List<String> getRowParameters()

getRowUrl

public String getRowUrl()

getScope

public CustomOperationScope getScope()

getScript

public CustomScript getScript()

getScriptParameters

public String getScriptParameters()

getScriptUsedInType

public CustomScriptUsedInType getScriptUsedInType()

Description copied from interface: UsesScript

Returns the type of script usage

Specified by:

getScriptUsedInType in interface UsesScript

getShowForm

public CustomOperationShowForm getShowForm()

getSvgIcon

public String getSvgIcon()

Specified by:

getSvgIcon in interface HasSvgIcon

getTransferTypes

public Set<TransferType> getTransferTypes()

getUserMenu

public UserMainMenu getUserMenu()

isAllowExport

public boolean isAllowExport()

isAllowPrint

public boolean isAllowPrint()

isEnabled

public boolean isEnabled()

Description copied from interface: UsesScript

Indicates whether this entity is enabled

Specified by:

isEnabled in interface UsesScript

isEnabledForActiveUsers

public boolean isEnabledForActiveUsers()

isEnabledForPendingUsers

public boolean isEnabledForPendingUsers()

isHasFileUpload

public boolean isHasFileUpload()

isOpenRowInNewWindow

public boolean isOpenRowInNewWindow()

isRequireConfirmationCredential

public boolean isRequireConfirmationCredential()

isSearchAutomatically

public boolean isSearchAutomatically()

isSubmitWithQrCodeScan

public boolean isSubmitWithQrCodeScan()

setActions

public void setActions(Set<CustomOperationAction> actions)

setAdminMenu

public void setAdminMenu(AdminMainMenu adminMenu)

setAllowExport

public void setAllowExport(boolean allowExport)

setAllowPrint

public void setAllowPrint(boolean allowPrint)

setChannels

public void setChannels(Set<Channel> channels)

setCloseAfterSeconds

public void setCloseAfterSeconds(Integer closeAfterSeconds)

setConfirmationText

public void setConfirmationText(String confirmationText)

setContentScript

public void setContentScript(CustomScript contentScript)

setContentScriptParameters

public void setContentScriptParameters(String contentScriptParameters)

setCustomSubmitLabel

public void setCustomSubmitLabel(String customSubmitLabel)

setEnabledForActiveUsers

public void setEnabledForActiveUsers(boolean enabledForActiveUsers)

setEnabledForPendingUsers

public void setEnabledForPendingUsers(boolean enabledForPendingUsers)

setFrontendMenu

public void setFrontendMenu(FrontendMenu frontendMenu)

setHasFileUpload

public void setHasFileUpload(boolean hasFileUpload)

setIcon

public void setIcon(String icon)

setInformationText

public void setInformationText(String informationText)

setLabel

public void setLabel(String label)

setNetwork

public void setNetwork(Network network)

Specified by:

setNetwork in interface DefinesNetwork

setOpenRowInNewWindow

public void setOpenRowInNewWindow(boolean openRowInNewWindow)

setProfileSection

public void setProfileSection(ProfileManagementSection profileSection)

setRecordTypes

public void setRecordTypes(Set<RecordType> recordTypes)

setRequireConfirmationCredential

public void setRequireConfirmationCredential(boolean requireConfirmationCredential)

setResultInformationText

public void setResultInformationText(String resultInformationText)

setResultType

public void setResultType(CustomOperationResultType resultType)

setRowLocation

public void setRowLocation(Location rowLocation)

setRowOperation

public void setRowOperation(CustomOperation rowOperation)

setRowParameters

public void setRowParameters(List<String> params)

setRowUrl

public void setRowUrl(String rowUrl)

setScope

public void setScope(CustomOperationScope scope)

setScript

public void setScript(CustomScript script)

setScriptParameters

public void setScriptParameters(String scriptParameters)

setSearchAutomatically

public void setSearchAutomatically(boolean searchAutomatically)

setShowForm

public void setShowForm(CustomOperationShowForm showForm)

setSubmitWithQrCodeScan

public void setSubmitWithQrCodeScan(boolean submitWithQrCodeScan)

setSvgIcon

public void setSvgIcon(String svgIcon)

Specified by:

setSvgIcon in interface HasSvgIcon

setTransferTypes

public void setTransferTypes(Set<TransferType> transferTypes)

setUserMenu

public void setUserMenu(UserMainMenu userMenu)