org.apache.isis.objectstore.jdo.applib.service.command

Class CommandJdo

java.lang.Object

org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

org.apache.isis.objectstore.jdo.applib.service.command.CommandJdo

All Implemented Interfaces:

org.apache.isis.applib.services.command.Command, org.apache.isis.applib.services.HasTransactionId

public class CommandJdo
extends org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract
implements org.apache.isis.applib.services.command.Command

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract.ChangeType

Nested classes/interfaces inherited from interface org.apache.isis.applib.services.command.Command

org.apache.isis.applib.services.command.Command.Executor

Constructor Summary

Constructors

Constructor and Description
CommandJdo()

Method Summary

Methods

Modifier and Type	Method and Description
String	getArguments()
Timestamp	getCompletedAt() The date/time at which this interaction completed.
BigDecimal	getDuration() The number of seconds (to 3 decimal places) that this interaction lasted.
String	getException() Stack trace of any exception that might have occurred if this interaction/transaction aborted.
org.apache.isis.applib.annotation.Command.ExecuteIn	getExecuteIn() Whether the action was invoked explicitly by the user, or scheduled as a background task, or as for some other reason, eg a side-effect of rendering an object due to get-after-post).
org.apache.isis.applib.services.command.Command.Executor	getExecutor()
String	getMemberIdentifier()
String	getMemento()
org.apache.isis.applib.services.command.Command	getParent()
org.apache.isis.applib.annotation.Command.Persistence	getPersistence()
org.apache.isis.applib.services.bookmark.Bookmark	getResult()
String	getResultStr()
String	getResultSummary()
Timestamp	getStartedAt()
String	getTargetAction()
String	getTargetClass()
String	getTargetStr()
Timestamp	getTimestamp() The date/time at which this action was created.
UUID	getTransactionId() The unique identifier (a GUID) of the transaction in which this command occurred.
String	getUser()
boolean	hideOpenResultObject()
boolean	hideShowException()
boolean	isCausedException()
boolean	isComplete()
boolean	isPersistHint()
int	next(String sequenceName)
Object	openResultObject()
void	setArguments(String arguments)
void	setCompletedAt(Timestamp completed)
void	setException(String exception)
void	setExecuteIn(org.apache.isis.applib.annotation.Command.ExecuteIn nature) NOT API: intended to be called only by the framework.
void	setExecutor(org.apache.isis.applib.services.command.Command.Executor nature)
void	setMemberIdentifier(String memberIdentifier)
void	setMemento(String memento)
void	setParent(org.apache.isis.applib.services.command.Command parent)
void	setPersistence(org.apache.isis.applib.annotation.Command.Persistence persistence)
void	setPersistHint(boolean persistHint)
void	setResult(org.apache.isis.applib.services.bookmark.Bookmark result)
void	setResultStr(String resultStr)
void	setStartedAt(Timestamp startedAt) NOT API: intended to be called only by the framework.
void	setTargetAction(String targetAction)
void	setTargetClass(String targetClass)
void	setTargetStr(String targetStr)
void	setTimestamp(Timestamp timestamp) NOT API: intended to be called only by the framework.
void	setTransactionId(UUID transactionId) NOT API: intended to be called only by the framework.
void	setUser(String user)
String	showException()
String	title()
String	toString()

Methods inherited from class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

compareByTargetThenTimestampDescThenType, compareByTargetThenUserThenTimestampDescThenType, compareByTimestampDescThenType, compareByUserThenTargetThenTimestampDescThenType, compareByUserThenTimestampDescThenType, getPostValue, getPreValue, getPropertyId, getTarget, getType, hideOpenTargetObject, openTargetObject, setTarget

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.isis.applib.services.command.Command

getTarget, setTarget

Constructor Detail

CommandJdo

public CommandJdo()

Method Detail

title

public String title()

getUser

public String getUser()

Specified by:

getUser in interface org.apache.isis.applib.services.command.Command

Overrides:

getUser in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

setUser

public void setUser(String user)

Specified by:

setUser in interface org.apache.isis.applib.services.command.Command

getTimestamp

public Timestamp getTimestamp()

The date/time at which this action was created.

Specified by:

getTimestamp in interface org.apache.isis.applib.services.command.Command

Overrides:

getTimestamp in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

setTimestamp

public void setTimestamp(Timestamp timestamp)

NOT API: intended to be called only by the framework.

Specified by:

setTimestamp in interface org.apache.isis.applib.services.command.Command

getExecutor

public org.apache.isis.applib.services.command.Command.Executor getExecutor()

Specified by:

getExecutor in interface org.apache.isis.applib.services.command.Command

setExecutor

public void setExecutor(org.apache.isis.applib.services.command.Command.Executor nature)

Specified by:

setExecutor in interface org.apache.isis.applib.services.command.Command

getExecuteIn

public org.apache.isis.applib.annotation.Command.ExecuteIn getExecuteIn()

Whether the action was invoked explicitly by the user, or scheduled as a background task, or as for some other reason, eg a side-effect of rendering an object due to get-after-post).

Specified by:

getExecuteIn in interface org.apache.isis.applib.services.command.Command

setExecuteIn

public void setExecuteIn(org.apache.isis.applib.annotation.Command.ExecuteIn nature)

NOT API: intended to be called only by the framework.

Specified by:

setExecuteIn in interface org.apache.isis.applib.services.command.Command

getParent

public org.apache.isis.applib.services.command.Command getParent()

Specified by:

getParent in interface org.apache.isis.applib.services.command.Command

setParent

public void setParent(org.apache.isis.applib.services.command.Command parent)

Specified by:

setParent in interface org.apache.isis.applib.services.command.Command

getTransactionId

public UUID getTransactionId()

The unique identifier (a GUID) of the transaction in which this command occurred.

Specified by:

getTransactionId in interface org.apache.isis.applib.services.HasTransactionId

Overrides:

getTransactionId in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

setTransactionId

public void setTransactionId(UUID transactionId)

NOT API: intended to be called only by the framework.

Implementation notes: copied over from the Isis transaction when the command is persisted.

Specified by:

setTransactionId in interface org.apache.isis.applib.services.HasTransactionId

getTargetClass

public String getTargetClass()

Specified by:

getTargetClass in interface org.apache.isis.applib.services.command.Command

Overrides:

getTargetClass in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

setTargetClass

public void setTargetClass(String targetClass)

Specified by:

setTargetClass in interface org.apache.isis.applib.services.command.Command

getTargetAction

public String getTargetAction()

Specified by:

getTargetAction in interface org.apache.isis.applib.services.command.Command

Overrides:

getTargetAction in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

setTargetAction

public void setTargetAction(String targetAction)

Specified by:

setTargetAction in interface org.apache.isis.applib.services.command.Command

getTargetStr

public String getTargetStr()

Overrides:

getTargetStr in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

setTargetStr

public void setTargetStr(String targetStr)

Specified by:

setTargetStr in class org.apache.isis.objectstore.jdo.applib.service.DomainChangeJdoAbstract

getArguments

public String getArguments()

Specified by:

getArguments in interface org.apache.isis.applib.services.command.Command

setArguments

public void setArguments(String arguments)

Specified by:

setArguments in interface org.apache.isis.applib.services.command.Command

getMemberIdentifier

public String getMemberIdentifier()

Specified by:

getMemberIdentifier in interface org.apache.isis.applib.services.command.Command

setMemberIdentifier

public void setMemberIdentifier(String memberIdentifier)

Specified by:

setMemberIdentifier in interface org.apache.isis.applib.services.command.Command

getMemento

public String getMemento()

Specified by:

getMemento in interface org.apache.isis.applib.services.command.Command

setMemento

public void setMemento(String memento)

Specified by:

setMemento in interface org.apache.isis.applib.services.command.Command

getStartedAt

public Timestamp getStartedAt()

Specified by:

getStartedAt in interface org.apache.isis.applib.services.command.Command

setStartedAt

public void setStartedAt(Timestamp startedAt)

NOT API: intended to be called only by the framework.

Specified by:

setStartedAt in interface org.apache.isis.applib.services.command.Command

getCompletedAt

public Timestamp getCompletedAt()

The date/time at which this interaction completed.

Specified by:

getCompletedAt in interface org.apache.isis.applib.services.command.Command

setCompletedAt

public void setCompletedAt(Timestamp completed)

Specified by:

setCompletedAt in interface org.apache.isis.applib.services.command.Command

getDuration

@Digits(integer=5,
        fraction=3)
public BigDecimal getDuration()

The number of seconds (to 3 decimal places) that this interaction lasted.

Populated only if it has completed.

isComplete

public boolean isComplete()

getResultSummary

public String getResultSummary()

getResult

public org.apache.isis.applib.services.bookmark.Bookmark getResult()

Specified by:

getResult in interface org.apache.isis.applib.services.command.Command

setResult

public void setResult(org.apache.isis.applib.services.bookmark.Bookmark result)

Specified by:

setResult in interface org.apache.isis.applib.services.command.Command

getResultStr

public String getResultStr()

setResultStr

public void setResultStr(String resultStr)

openResultObject

public Object openResultObject()

hideOpenResultObject

public boolean hideOpenResultObject()

getException

public String getException()

Stack trace of any exception that might have occurred if this interaction/transaction aborted.

Not visible in the UI, but accessible

Not part of the applib API, because the default implementation is not persistent and so there's no object that can be accessed to be annotated.

Specified by:

getException in interface org.apache.isis.applib.services.command.Command

setException

public void setException(String exception)

Specified by:

setException in interface org.apache.isis.applib.services.command.Command

isCausedException

public boolean isCausedException()

showException

public String showException()

hideShowException

public boolean hideShowException()

next

public int next(String sequenceName)

Specified by:

next in interface org.apache.isis.applib.services.command.Command

getPersistence

public org.apache.isis.applib.annotation.Command.Persistence getPersistence()

Specified by:

getPersistence in interface org.apache.isis.applib.services.command.Command

setPersistence

public void setPersistence(org.apache.isis.applib.annotation.Command.Persistence persistence)

Specified by:

setPersistence in interface org.apache.isis.applib.services.command.Command

isPersistHint

public boolean isPersistHint()

Specified by:

isPersistHint in interface org.apache.isis.applib.services.command.Command

setPersistHint

public void setPersistHint(boolean persistHint)

Specified by:

setPersistHint in interface org.apache.isis.applib.services.command.Command

toString

public String toString()

Overrides:

toString in class Object