Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver 2004S SPS 10
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.sap.caf.eu.gp.structure.api

Interface IGPStructure

public interface IGPStructure

Respresents the runtime instances of the structures. Contains the structure attributes. Substructures can be added, attribute values can retreived and updated.

Method Summary
 IGPStructure addStructure(String name)
          Adds a new structure with the specified name and no namespace.
 IGPStructure addStructure(String name, String namespace)
          Adds a new structure with the specified name and no namespace.
 Object getAttribute(String attributeName)
          Returns the value of the attribute with the specified name and no namespace
 Object getAttribute(String attributeName, String namespace)
          Returns the value of the attribute with the specified name and namespace
 BigDecimal getAttributeAsBigDecimal(String name)
          Gets the value of the attribute with the specified name and no namespace.
 BigDecimal getAttributeAsBigDecimal(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 BigInteger getAttributeAsBigInteger(String name)
          Gets the value of the attribute with the specified name and no namespace.
 BigInteger getAttributeAsBigInteger(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 boolean getAttributeAsBoolean(String name)
          Gets the value of the attribute with the specified name and no namespace.
 boolean getAttributeAsBoolean(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 byte getAttributeAsByte(String name)
          Gets the value of the attribute with the specified name and no namespace.
 byte getAttributeAsByte(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 byte[] getAttributeAsByteArray(String name)
          Gets the value of the attribute with the specified name and no namespace.
 byte[] getAttributeAsByteArray(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 Date getAttributeAsDate(String name)
          Gets the value of the attribute with the specified name and no namespace.
 Date getAttributeAsDate(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 double getAttributeAsDouble(String name)
          Gets the value of the attribute with the specified name and no namespace.
 double getAttributeAsDouble(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 int getAttributeAsInt(String name)
          Gets the value of the attribute with the specified name and no namespace.
 int getAttributeAsInt(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 long getAttributeAsLong(String name)
          Gets the value of the attribute with the specified name and no namespace.
 long getAttributeAsLong(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 short getAttributeAsShort(String name)
          Gets the value of the attribute with the specified name and no namespace.
 short getAttributeAsShort(String name, String namespace)
          Gets the value of the attribute with the specified name and namespace.
 String getAttributeAsString(String attributeName)
          Returns a stringified value of the attribute with the specified name and no namespace
 String getAttributeAsString(String attributeName, String namespace)
          Returns a stringified value of the attribute with the specified name and namespace
 Collection getAttributeValues(String name)
          Returns collection values of the attribute with the specified name and no namespace.
 Collection getAttributeValues(String name, String namespace)
          Returns collection values of the attribute with the specified name and namespace.
 IGPStructure getParentStructure()
          Returns the parent structrue instance of the current structure instance.
 IGPStructure getStructure(String name)
          Returns a substructure instance with the specified name and no namespace.
 IGPStructure getStructure(String name, String namespace)
          Returns a substructure instance with the specified name and namespace.
 IGPStructureInfo getStructureInfo()
          Returns the structure definition of the current structure instance
 Collection getStructures(String name)
          Returns all substructure instances with the specified name and no namespace.
 Collection getStructures(String name, String namespace)
          Returns all substructure instances with the specified name and namespace.
 void setAttributeValue(String name, BigDecimal value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, BigInteger value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, boolean value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, byte value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, byte[] value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, Date value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, double value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, int value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, long value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, Object value)
          Sets the value of the attribute with the specified name and no namespace
 void setAttributeValue(String name, short value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, String value)
          Sets new value of the attribute with the specified name and no namespace.
 void setAttributeValue(String name, String namespace, BigDecimal value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, BigInteger value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, boolean value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, byte value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, byte[] value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, Date value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, double value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, int value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, long value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, Object value)
          Sets the value of the attribute with the specified name and no namespace
 void setAttributeValue(String name, String namespace, short value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValue(String name, String namespace, String value)
          Sets new value of the attribute with the specified name and namespace.
 void setAttributeValues(String name, Collection values)
          Sets new values for the attribute with the specified name and namespace.
 void setAttributeValues(String name, String namespace, Collection values)
          Sets new values for the attribute with the specified name and namespace.
 String toString()
          Overriden default-method.
 

Method Detail

getStructureInfo

public IGPStructureInfo getStructureInfo()
Returns the structure definition of the current structure instance

Returns:
the structure definition of the current structure instance

getParentStructure

public IGPStructure getParentStructure()
Returns the parent structrue instance of the current structure instance.

Returns:
the parent structure instance

getAttribute

public Object getAttribute(String attributeName)
                    throws GPInvocationException
Returns the value of the attribute with the specified name and no namespace

Parameters:
attributeName - the name of the attribute
Returns:
the attribute value as java.lang.Object
Throws:
GPInvocationException

getAttribute

public Object getAttribute(String attributeName,
                           String namespace)
                    throws GPInvocationException
Returns the value of the attribute with the specified name and namespace

Parameters:
attributeName - the name of the attribute
namespace - the attribute namespace
Returns:
the value of the attribute as java.lang.Object
Throws:
GPInvocationException

getAttributeAsString

public String getAttributeAsString(String attributeName)
                            throws GPInvocationException
Returns a stringified value of the attribute with the specified name and no namespace

Parameters:
attributeName - the attribute name
Returns:
the stringified value of the attribute
Throws:
GPInvocationException

getAttributeAsString

public String getAttributeAsString(String attributeName,
                                   String namespace)
                            throws GPInvocationException
Returns a stringified value of the attribute with the specified name and namespace

Parameters:
attributeName - the name of the attribute
namespace - the namespace of the attribute
Returns:
the stringified value of the attribute
Throws:
GPInvocationException

setAttributeValue

public void setAttributeValue(String name,
                              Object value)
                       throws GPInvocationException
Sets the value of the attribute with the specified name and no namespace

Parameters:
name - the name of the attribute
value - the new attribute value
Throws:
GPInvocationException

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              Object value)
                       throws GPInvocationException
Sets the value of the attribute with the specified name and no namespace

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new attribute value
Throws:
GPInvocationException

getStructure

public IGPStructure getStructure(String name)
                          throws GPInvocationException
Returns a substructure instance with the specified name and no namespace. The method is used for substructure with cardinality 0..1 and 1..1. If it is used with list substructures it returns the first value in the list.

Parameters:
name - the name of the substructure
Returns:
the structure instance
Throws:
GPInvocationException

getStructure

public IGPStructure getStructure(String name,
                                 String namespace)
                          throws GPInvocationException
Returns a substructure instance with the specified name and namespace. The method is used for substructure with cardinality 0..1 and 1..1. If it is used with list substructures it returns the first value in the list.

Parameters:
name - the name of the substructure
namespace - the namespace of the substructure
Returns:
the structure instance
Throws:
GPInvocationException

getStructures

public Collection getStructures(String name)
                         throws GPInvocationException
Returns all substructure instances with the specified name and no namespace. The method is used for substructure with cardinality 0..N and 1..N.

Parameters:
name - the name of the substructure
Returns:
collection of all substructure instances
Throws:
GPInvocationException

getStructures

public Collection getStructures(String name,
                                String namespace)
                         throws GPInvocationException
Returns all substructure instances with the specified name and namespace. The method is used for substructure with cardinality 0..N and 1..N.

Parameters:
name - the name of the substructure
Returns:
collection of all substructure instances
Throws:
GPInvocationException

addStructure

public IGPStructure addStructure(String name)
                          throws GPInvocationException
Adds a new structure with the specified name and no namespace. If the structure is a list, a new structure instance is added to the list. If the structure is with singleton cardinality the new structure overrides any existing structure.

Parameters:
name - the name of the structure instance to be created
Returns:
the created structure
Throws:
GPInvocationException

addStructure

public IGPStructure addStructure(String name,
                                 String namespace)
                          throws GPInvocationException
Adds a new structure with the specified name and no namespace. If the structure is a list, a new structure instance is added to the list. If the structure is with singleton cardinality the new structure overrides any existing structure.

Parameters:
name - the name of the structure instance to be created
namespace - the namespace of the structure to be created
Returns:
the created structure
Throws:
GPInvocationException

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              BigDecimal value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              BigDecimal value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              BigInteger value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              BigInteger value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              boolean value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              boolean value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              byte value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              byte value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              byte[] value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              byte[] value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              Date value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              Date value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              double value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              double value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              int value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              int value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              long value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              long value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              short value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              short value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String namespace,
                              String value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

setAttributeValue

public void setAttributeValue(String name,
                              String value)
                       throws GPInvocationException
Sets new value of the attribute with the specified name and no namespace. The new value is constructed by using the value parameter. The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
value - the new value of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such an attribute in this structure
  • If value can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use setAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, setAttributeValues

getAttributeAsBigDecimal

public BigDecimal getAttributeAsBigDecimal(String name,
                                           String namespace)
                                    throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsBigDecimal

public BigDecimal getAttributeAsBigDecimal(String name)
                                    throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsBigInteger

public BigInteger getAttributeAsBigInteger(String name,
                                           String namespace)
                                    throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsBigInteger

public BigInteger getAttributeAsBigInteger(String name)
                                    throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsBoolean

public boolean getAttributeAsBoolean(String name,
                                     String namespace)
                              throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsBoolean

public boolean getAttributeAsBoolean(String name)
                              throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsByte

public byte getAttributeAsByte(String name,
                               String namespace)
                        throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsByte

public byte getAttributeAsByte(String name)
                        throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsByteArray

public byte[] getAttributeAsByteArray(String name,
                                      String namespace)
                               throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsByteArray

public byte[] getAttributeAsByteArray(String name)
                               throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsDate

public Date getAttributeAsDate(String name,
                               String namespace)
                        throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsDate

public Date getAttributeAsDate(String name)
                        throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsDouble

public double getAttributeAsDouble(String name,
                                   String namespace)
                            throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsDouble

public double getAttributeAsDouble(String name)
                            throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsInt

public int getAttributeAsInt(String name,
                             String namespace)
                      throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsInt

public int getAttributeAsInt(String name)
                      throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsLong

public long getAttributeAsLong(String name,
                               String namespace)
                        throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsLong

public long getAttributeAsLong(String name)
                        throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsShort

public short getAttributeAsShort(String name,
                                 String namespace)
                          throws GPInvocationException
Gets the value of the attribute with the specified name and namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

getAttributeAsShort

public short getAttributeAsShort(String name)
                          throws GPInvocationException
Gets the value of the attribute with the specified name and no namespace. The return value is constructed by using the internal value. The return type must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..1 and 1..1.

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If the internal value can not be converted to the return type.See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..N or 1..N. In such case you should use getAttributeValues
GPInvocationException
See Also:
IGPAttributeInfo, getAttributeValues

setAttributeValues

public void setAttributeValues(String name,
                               String namespace,
                               Collection values)
                        throws GPInvocationException
Sets new values for the attribute with the specified name and namespace. The new values are constructed by using the values collection.

All objects in the values collection must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..N and 1..N.

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
values - the new values of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is not such attribute in this structure.
  • If an object from values can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..1 or 1..1. In such case you should use setAttributeValue methods
GPInvocationException
See Also:
IGPAttributeInfo

setAttributeValues

public void setAttributeValues(String name,
                               Collection values)
                        throws GPInvocationException
Sets new values for the attribute with the specified name and namespace. The new values are constructed by using the values collection.

All objects in the values collection must be compatible with the base type of the attribute.

The method is used for attributes with cardinality 0..N and 1..N.

Parameters:
name - the name of the attribute
values - the new values of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is no such an attribute in this structure
  • If an object from values can not be converted to the Java type that represents the attribute's base type. See IGPAttributeInfo.BASE_* fields for more information
  • If the cardinality of the attribute is 0..1 or 1..1. In such case you should use setAttributeValue methods
GPInvocationException
See Also:
IGPAttributeInfo

getAttributeValues

public Collection getAttributeValues(String name,
                                     String namespace)
                              throws GPInvocationException
Returns collection values of the attribute with the specified name and namespace. The collection holds objects of java type that corresponds to the base type of the attribute. See IGPAttributeInfo.BASE_* fields for more information

The method is used for attributes with cardinality 0..N and 1..N

Parameters:
name - the name of the attribute
namespace - the namespace of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is no such an attribute in this structure
  • If the cardinality of the attribute is 0..1 or 1..1. In such case you should use getAttributeValueAs* methods}
GPInvocationException
See Also:
IGPAttributeInfo

getAttributeValues

public Collection getAttributeValues(String name)
                              throws GPInvocationException
Returns collection values of the attribute with the specified name and no namespace. The collection holds objects of java type that corresponds to the base type of the attribute. See IGPAttributeInfo.BASE_* fields for more information

The method is used for attributes with cardinality 0..N and 1..N

Parameters:
name - the name of the attribute
Throws:
InvocationException -
  • If name is null
  • If there is no such an attribute in this structure
  • If the cardinality of the attribute is 0..1 or 1..1. In such case you should use getAttributeValueAs* methods}
GPInvocationException
See Also:
IGPAttributeInfo

toString

public String toString()
Overriden default-method. Returns IGPStructure as an NON-STANDARDIZED XML-Tree

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver 2004S SPS 10
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG Complete Copyright Notice