com.sas.cas

Class CASActionInfo

java.lang.Object

com.sas.cas.CASActionInfo

All Implemented Interfaces:

CASProtoTranslator, java.io.Serializable

public class CASActionInfo
extends java.lang.Object
implements CASProtoTranslator, java.io.Serializable

Describes an action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CASActionInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionSetName() Gets the action set name for this action.
java.lang.String	getDescription() Gets the action description, or label.
java.lang.String	getLabel() Gets the action label, or null for none.
java.lang.String	getName() Gets the action name.
java.util.List<CASActionParameterInfo>	getParameters() Gets the parameters for this action.
boolean	handleValue(CASActionOptions options, com.sas.cas.proto.CASClientProto.Value value) Handles a protobuf value.
boolean	isDisabled() Returns true if this action is disabled, perhaps due to authorization.
boolean	isHidden() Returns true if this action is hidden, such as a deprecated action.
boolean	isMultiRequest() Returns true if this action uses a multi-request scheme to transfer data.
boolean	isUserFlag01() User flag 01
boolean	isUserFlag02() User flag 02
boolean	isUserFlag03() User flag 03
boolean	isUserFlag04() User flag 04
boolean	isUserFlag05() User flag 05
boolean	isUserFlag06() User flag 06
boolean	isUserFlag07() User flag 07
boolean	isUserFlag08() User flag 08
void	setDisabled(boolean disabled)
void	setHidden(boolean hidden)
void	setMultiRequest(boolean multiRequest)
void	setUserFlag01(boolean userFlag01)
void	setUserFlag02(boolean userFlag02)
void	setUserFlag03(boolean userFlag03)
void	setUserFlag04(boolean userFlag04)
void	setUserFlag05(boolean userFlag05)
void	setUserFlag06(boolean userFlag06)
void	setUserFlag07(boolean userFlag07)
void	setUserFlag08(boolean userFlag08)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CASActionInfo

public CASActionInfo()

Method Detail

getActionSetName

public java.lang.String getActionSetName()

Gets the action set name for this action.

Returns:

The action set name

getName

public java.lang.String getName()

Gets the action name.

Returns:

The action name

getLabel

public java.lang.String getLabel()

Gets the action label, or null for none.

Returns:

The label

getDescription

public java.lang.String getDescription()

Gets the action description, or label.

Returns:

The action description

getParameters

public java.util.List<CASActionParameterInfo> getParameters()

Gets the parameters for this action.

Returns:

The parameters

isDisabled

public boolean isDisabled()

Returns true if this action is disabled, perhaps due to authorization.

Returns:

True if disabled

setDisabled

public void setDisabled(boolean disabled)

isHidden

public boolean isHidden()

Returns true if this action is hidden, such as a deprecated action.

Returns:

true if hidden

setHidden

public void setHidden(boolean hidden)

isMultiRequest

public boolean isMultiRequest()

Returns true if this action uses a multi-request scheme to transfer data. An example would be the upload action.

Returns:

true if a multirequest action

setMultiRequest

public void setMultiRequest(boolean multiRequest)

isUserFlag01

public boolean isUserFlag01()

User flag 01

setUserFlag01

public void setUserFlag01(boolean userFlag01)

isUserFlag02

public boolean isUserFlag02()

User flag 02

setUserFlag02

public void setUserFlag02(boolean userFlag02)

isUserFlag03

public boolean isUserFlag03()

User flag 03

setUserFlag03

public void setUserFlag03(boolean userFlag03)

isUserFlag04

public boolean isUserFlag04()

User flag 04

setUserFlag04

public void setUserFlag04(boolean userFlag04)

isUserFlag05

public boolean isUserFlag05()

User flag 05

setUserFlag05

public void setUserFlag05(boolean userFlag05)

isUserFlag06

public boolean isUserFlag06()

User flag 06

setUserFlag06

public void setUserFlag06(boolean userFlag06)

isUserFlag07

public boolean isUserFlag07()

User flag 07

setUserFlag07

public void setUserFlag07(boolean userFlag07)

isUserFlag08

public boolean isUserFlag08()

User flag 08

setUserFlag08

public void setUserFlag08(boolean userFlag08)

handleValue

public boolean handleValue(CASActionOptions options,
                           com.sas.cas.proto.CASClientProto.Value value)

Description copied from interface: CASProtoTranslator

Handles a protobuf value.

Specified by:

handleValue in interface CASProtoTranslator

Parameters:

options - The current CAS action options

value - The protobuf value

Returns:

true if the value was handled

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object