com.sap.aii.af.service.cpa

Interface CPAObject

All Superinterfaces:

Comparable<CPAObject>

All Known Subinterfaces:

AttributeExtendedCPAObject, Binding, BindingUser, Channel, ModuleConfig, Party, PartyIdentifier, Service, ServiceIdentifier, ServiceUser

public interface CPAObject
extends Comparable<CPAObject>

The CPAObject is the central interface that is implemented by all actual CPA Object types. It is used as parameters and return values for all lookup methods.

Version:

$Id: //tc/xpi.af/NW711_03_COR/src/_cpa_service_module/libm/api/com/sap/aii/af/service/cpa/CPAObject.java#1 $

Method Summary

String	getObjectId()
String	getObjectName()
CPAObjectType	getObjectType()
String	getStringRepresentation() Creates a detailed String representation of the complete CPAObject.
Object	getValue(String name) Returns a specific value field's data, identified by the given name (as Object).
BinaryData	getValueAsBinary(String name) Returns a specific value field's data, identified by the given name (as Binary data).
boolean	getValueAsBoolean(String name) Returns a specific value field's data, identified by the given name (as boolean).
Date	getValueAsDate(String name) Returns a specific value field's data, identified by the given name (as Datea).
int	getValueAsInt(String name) Returns a specific value field's data, identified by the given name (as int).
Integer	getValueAsIntObject(String name) Returns a specific value field's data, identified by the given name (as int).
long	getValueAsLong(String name) Returns a specific value field's data, identified by the given name (as long).
Long	getValueAsLongObject(String name) Returns a specific value field's data, identified by the given name (as long).
String	getValueAsString(String name) Returns a specific value field's data, identified by the given name (as String).
TableData	getValueAsTable(String name) Returns a specific value field's data, identified by the given name (as Table data).
Timestamp	getValueAsTimestamp(String name) Returns a specific value field's data, identified by the given name (as Timestamp).
boolean	isPassword(String name) Checks if the given field is a password.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getObjectId

String getObjectId()

getObjectName

String getObjectName()

getObjectType

CPAObjectType getObjectType()

getValue

Object getValue(String name)
                throws CPAException

Returns a specific value field's data, identified by the given name (as Object).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

isPassword

boolean isPassword(String name)
                   throws CPAException

Checks if the given field is a password.

Parameters:

name - The name of the field to check.

Returns:

True, if the field is a password, otherwise false.

Throws:

CPAException

getValueAsString

String getValueAsString(String name)
                        throws CPAException

Returns a specific value field's data, identified by the given name (as String).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsInt

int getValueAsInt(String name)
                  throws CPAException

Returns a specific value field's data, identified by the given name (as int).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsIntObject

Integer getValueAsIntObject(String name)
                            throws CPAException

Returns a specific value field's data, identified by the given name (as int).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsLong

long getValueAsLong(String name)
                    throws CPAException

Returns a specific value field's data, identified by the given name (as long).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsLongObject

Long getValueAsLongObject(String name)
                          throws CPAException

Returns a specific value field's data, identified by the given name (as long).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsBoolean

boolean getValueAsBoolean(String name)
                          throws CPAException

Returns a specific value field's data, identified by the given name (as boolean).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsBinary

BinaryData getValueAsBinary(String name)
                            throws CPAException

Returns a specific value field's data, identified by the given name (as Binary data).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsTable

TableData getValueAsTable(String name)
                          throws CPAException

Returns a specific value field's data, identified by the given name (as Table data).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsTimestamp

Timestamp getValueAsTimestamp(String name)
                              throws CPAException

Returns a specific value field's data, identified by the given name (as Timestamp).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getValueAsDate

Date getValueAsDate(String name)
                    throws CPAException

Returns a specific value field's data, identified by the given name (as Datea).

Parameters:

name - The name of the requested value data.

Returns:

The requested value field data.

Throws:

CPAException

getStringRepresentation

String getStringRepresentation()

Creates a detailed String representation of the complete CPAObject.

Returns:

The detailed String representation of the complete CPAObject.