org.asam.ods

Interface ApplElemAccessOperations

All Known Subinterfaces:

ApplElemAccess

All Known Implementing Classes:

_ApplElemAccessStub, ApplElemAccess, ApplElemAccess, ApplElemAccessPOA

public interface ApplElemAccessOperations

The application element access. The ApplElemAccess interface provides query methods to retrieve instances of application elements. Currently available query methods are: - query with attribute and value - query with attribute and values (not)in set - sorted results - grouped results including having condition

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteInstances(T_LONGLONG aid, T_LONGLONG[] instIds) (24006) Delete instances from an application element.
ACL[]	getAttributeRights(T_LONGLONG aid, java.lang.String attrName) (24011) Retrieve access control list information for the given application attribute /.
InitialRight[]	getElementInitialRights(T_LONGLONG aid) (24018) Retrieve access control list information of the initial rights for the requested application element .
ACL[]	getElementRights(T_LONGLONG aid) (24012) Retrieve access control list information for the requested application element .
java.lang.String[]	getInitialRightReference(T_LONGLONG aid) (24017) Get all attribute names (references) which are used to retrieve the Initial Rights.
InitialRight[]	getInstanceInitialRights(T_LONGLONG aid, T_LONGLONG iid) (24019) Retrieve access control list information of the initial rights for the requested instance /.
ACL[]	getInstanceRights(T_LONGLONG aid, T_LONGLONG iid) (24013) Retrieve access control list information for the requested instance /.
ElemResultSet[]	getInstances(QueryStructure aoq, int how_many) (24001) Perform the Query.
ResultSetExt[]	getInstancesExt(QueryStructureExt aoq, int how_many) (24020) Perform the Query.
ODSFile	getODSFile(ElemId elem) (24022) Get the ODSFile interface for an instance of an application element derived from AoFile.
T_LONGLONG[]	getRelInst(ElemId elem, java.lang.String relName) (24002) Get related instances (Id).
ValueMatrix	getValueMatrix(ElemId elem) (24007) Get the value matrix of a measurement or a submatrix.
ValueMatrix	getValueMatrixInMode(ElemId elem, ValueMatrixMode vmMode) (24021) Get the value matrix of a measurement or a submatrix.
ElemId[]	insertInstances(AIDNameValueSeqUnitId[] val) (24004) Create instance elements of an application element.
void	setAttributeRights(T_LONGLONG aid, java.lang.String attrName, T_LONGLONG usergroupId, int rights, RightsSet set) (24008) Set the ACL information on some application element-attribute defined by and .
void	setElementInitialRights(T_LONGLONG aid, T_LONGLONG usergroupId, int rights, T_LONGLONG refAid, RightsSet set) (24014) Set the access control list information for the initial rights on some application element defined by .
void	setElementRights(T_LONGLONG aid, T_LONGLONG usergroupId, int rights, RightsSet set) (24009) Set the ACL information on some application element defined by .
void	setInitialRightReference(T_LONGLONG aid, java.lang.String refName, RightsSet set) (24016) Set the flag in svcattr, if this reference will be used (or not) to retrieve the Initial Rights.
void	setInstanceInitialRights(T_LONGLONG aid, T_LONGLONG[] instIds, T_LONGLONG usergroupId, int rights, T_LONGLONG refAid, RightsSet set) (24015) Set the access control list information for the initial rights on some instance defined by the application element id and a sequence of instances defined by the id .
void	setInstanceRights(T_LONGLONG aid, T_LONGLONG[] instIds, T_LONGLONG usergroupId, int rights, RightsSet set) (24010) Set the ACL information on some instances defined by the application element id and a sequence of instances defined by the id .
void	setRelInst(ElemId elem, java.lang.String relName, T_LONGLONG[] instIds, SetType type) (24003) Add a set of instances as related instances to a given instance.
void	updateInstances(AIDNameValueSeqUnitId[] val) (24005) Update one or more attributes of one or more instance elements.

Method Detail

getInstances

ElemResultSet[] getInstances(QueryStructure aoq,
                           int how_many)
                             throws AoException

(24001) Perform the Query. The number of different application elements which are requested are exactly defined by the definition of the query given in the substructure anuSeq of QueryStructure. The number of attributes for each application element is also given in the definition. The number of matching instances (their attributes) is not defined by the query and can be a large amount. Therefore only one iterator for the attribute values are defined. The values of the localcolumn instances is part of the resultset when the following criteria all fit: - Only when the attributes id, generation_parameters, values, flags are requested (as soon as any other attributes are requested the values are not reported). - The values of the localcolumn must all belong to exactly one instance of AoMeasurement - The result set does not exceed the server memory limitation. An ASAM ODS server has a memory limitation (not the system memory limitation); as soon as the result set breaks this limitation an exception will be thrown. - No iterator for the rest is required. In case an attribute of blob type is among the requested attributes, the content of the return structure will depend on the number of instances that are returned: - In case attributes of only one instance are returned (either because 'how_many' was set to 1 or there is only one instance available at the server), the return structure contains the blob itself. -In case attributes of more than one instance are returned, the return structure does not contain the blobs; instead it contains the headers of the respective blobs.

Parameters:

aoq - The query definition.

how_many - Maximum number of values in each result set. Valid arguments are: how_many = 0 : report all found values, how_many > 0 : report a maximum number of values.

Returns:

The result set with the requested attribute values.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelInst

T_LONGLONG[] getRelInst(ElemId elem,
                      java.lang.String relName)
                        throws AoException

(24002) Get related instances (Id). This method returns a sequence of related instances. The relation name specifies the relation given in the ApplStructValue. The aid of the ElemId and the relName defines the unique relation and the target application element.

Parameters:

elem - Original instance.

relName - The relation name.

Returns:

The list of the Ids of the related instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setRelInst

void setRelInst(ElemId elem,
              java.lang.String relName,
              T_LONGLONG[] instIds,
              SetType type)
                throws AoException

(24003) Add a set of instances as related instances to a given instance.

Parameters:

elem - The instance to add to the given relation.

relName - The name of relation.

instIds - Sequence of instance id's.

type - The type of the modification, insert, update or remove.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

insertInstances

ElemId[] insertInstances(AIDNameValueSeqUnitId[] val)
                         throws AoException

(24004) Create instance elements of an application element. The application element is specified by the AID of input structure. The attribute names are specified by the name of the input structure. The values of one instance element are specified in the valueseq of the input structure. You can create several instance elements in one call by filling the valueseq of the input structure. The same index in the valueseq corresponds to the attributes values of one instance element. This method returns a sequence of Id's, the order is related to the order of instance element specified in the input structure. In case of inheritance, the method supports only instances of same subtype per call. The returned Id's are the Id's of the related super type instances. The client must supply all mandatory attributes and references within one single method call; otherwise the object cannot be made persistent by the server in the database without the risk of violating any database constraint.

Parameters:

val - The sequence of attributes and their values.

Returns:

List with the Id's of the new created instances.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

updateInstances

void updateInstances(AIDNameValueSeqUnitId[] val)
                     throws AoException

(24005) Update one or more attributes of one or more instance elements. It's necessary that the input structure includes also the Id attribute, the Id attribute will be used to select the instance elements. In case of inherited application elements the super type Id has to be included. The values of one instance element are specified in the valueseq of the input structure. The same index in the valueseq corresponds to the attributes values of one instance element. The server will update the values of the localcolumn instances when the following criteria all fit: - Only when the attributes id, generation_parameters, values, flags are given, as soon as any other attributes is given an exception is thrown. - The values of the localcolumn must all belong to exactly one instance of AoMeasurement - The amount of given values does not exceed the server memory limitation. An ASAM ODS server has a memory limitation (not the system memory limitation); as soon as the given values break the limitation an exception will be thrown.

Parameters:

val - The sequence of attributes and their values. At least one of the attribute values sequence must be a sequence with the Id.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

deleteInstances

void deleteInstances(T_LONGLONG aid,
                   T_LONGLONG[] instIds)
                     throws AoException

(24006) Delete instances from an application element. In case of inherited application elements the Id of the super type has to be specified. This method can be used to delete several instances of the same application element. The method removeInstance of the interface ApplicationElement to remove one instance of an application element with the children of the instance element.

Parameters:

aid - The application element Id.

instIds - The sequence of instance Id's.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getValueMatrix

ValueMatrix getValueMatrix(ElemId elem)
                           throws AoException

(24007) Get the value matrix of a measurement or a submatrix. If the value matrix will be built up with special submatrix link, use the interface Measurement. By calling this method, the value matrix mode of the returned value matrix will be taken from the context variable 'VALUEMATRIX_MODE'. For more information especially on different modes of the value matrix, see description at the method getValueMatrixInMode() of the interfaces 'Measurement' and 'SubMatrix'.

Parameters:

elem - The element id. The aid has to be the application element Id of the AoMeasurement or AoSubmatrix.

Returns:

The value matrix

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_INVALID_BASETYPE

setAttributeRights

void setAttributeRights(T_LONGLONG aid,
                      java.lang.String attrName,
                      T_LONGLONG usergroupId,
                      int rights,
                      RightsSet set)
                        throws AoException

(24008) Set the ACL information on some application element-attribute defined by and . The defines the user group the rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights. Restriction for the model: only one application element of the type AoUserGroup is allowed.

Parameters:

aid - The Id of the application element.

attrName - The name of the attribute.

usergroupId - The user group to set the rights for.

rights - The new right for the user group.

set - What to do with the new right.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

setElementRights

void setElementRights(T_LONGLONG aid,
                    T_LONGLONG usergroupId,
                    int rights,
                    RightsSet set)
                      throws AoException

(24009) Set the ACL information on some application element defined by . The defines the user group the rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights. Restriction for the model: only one application element of the type AoUserGroup is allowed.

Parameters:

aid - The Id of the application element.

usergroupId - The user group to set the rights for.

rights - The new rights for the user group. The rights constants are defined in the interface SecurityRights. The interface definition language IDL does not allow to set the values of enumerations thus the constant definitions had to be done in an interface.

set - What to do with the new right.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setInstanceRights

void setInstanceRights(T_LONGLONG aid,
                     T_LONGLONG[] instIds,
                     T_LONGLONG usergroupId,
                     int rights,
                     RightsSet set)
                       throws AoException

(24010) Set the ACL information on some instances defined by the application element id and a sequence of instances defined by the id . The defines the user group the rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights. Restriction for the model: only one application element of the type AoUserGroup is allowed.

Parameters:

aid - The Id of the application element.

instIds - The sequence of instance Id's.

usergroupId - The user group to set the rights for.

rights - The new right for the user group.

set - What to do with the new right.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getAttributeRights

ACL[] getAttributeRights(T_LONGLONG aid,
                       java.lang.String attrName)
                         throws AoException

(24011) Retrieve access control list information for the given application attribute /.

Parameters:

aid - The Id of the application element.

attrName - The name of the attribute.

Returns:

The access control list entries of the given application attribute.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getElementRights

ACL[] getElementRights(T_LONGLONG aid)
                       throws AoException

(24012) Retrieve access control list information for the requested application element .

Parameters:

aid - The Id of the application element.

Returns:

The access control list entries of the given application element.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInstanceRights

ACL[] getInstanceRights(T_LONGLONG aid,
                      T_LONGLONG iid)
                        throws AoException

(24013) Retrieve access control list information for the requested instance /.

Parameters:

aid - The Id of the application element.

iid - The Id of the instance.

Returns:

The access control list entries of the given instance.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setElementInitialRights

void setElementInitialRights(T_LONGLONG aid,
                           T_LONGLONG usergroupId,
                           int rights,
                           T_LONGLONG refAid,
                           RightsSet set)
                             throws AoException

(24014) Set the access control list information for the initial rights on some application element defined by . The defines the user group the rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights. Restriction for the model: only one application element of the type AoUserGroup is allowed.

Parameters:

aid - The Id of the application element.

usergroupId - The user group to set the initial rights for.

rights - The new initial rights for the user group. The rights constants are defined in the interface SecurityRights. The interface definition language IDL does not allow to set the values of enumerations thus the constant definitions have to be done in an interface.

refAid - The Id of referencing application element for which the initial rights will be used. If no refAid is set the initial rights will be used for each new instance element independent of the application element.

set - What to do with the new initial rights.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setInstanceInitialRights

void setInstanceInitialRights(T_LONGLONG aid,
                            T_LONGLONG[] instIds,
                            T_LONGLONG usergroupId,
                            int rights,
                            T_LONGLONG refAid,
                            RightsSet set)
                              throws AoException

(24015) Set the access control list information for the initial rights on some instance defined by the application element id and a sequence of instances defined by the id . The defines the user group the rights should be set for. defines the rights to set or to clear. If the parameter is set to 'set', the rights in are set all others are cleared. If the parameter is set to 'add', the rights in are added to the existing rights. If the parameter is set to 'remove', the rights in are removed from the existing rights. Restriction for the model: only one application element of the type AoUserGroup is allowed.

Parameters:

aid - The Id of the application element.

instIds - The sequence of instance Id's.

usergroupId - The user group to set the initial rights for.

rights - The new initial right for the user group.

refAid - The Id of referencing application element for which the initial rights will be used. If no refAid is set the initial rights will be used for each new instance element independent of the application element.

set - What to do with the new initial rights.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setInitialRightReference

void setInitialRightReference(T_LONGLONG aid,
                            java.lang.String refName,
                            RightsSet set)
                              throws AoException

(24016) Set the flag in svcattr, if this reference will be used (or not) to retrieve the Initial Rights. If more than one reference is set to true, the union (or-function) of all rights are used.

Parameters:

aid - The application element Id.

refName - The name of the reference.

set - What to do with the given reference.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getInitialRightReference

java.lang.String[] getInitialRightReference(T_LONGLONG aid)
                                            throws AoException

(24017) Get all attribute names (references) which are used to retrieve the Initial Rights.

Parameters:

aid - The application element Id.

Returns:

The names of the references which will be used for the initial rights determination.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getElementInitialRights

InitialRight[] getElementInitialRights(T_LONGLONG aid)
                                       throws AoException

(24018) Retrieve access control list information of the initial rights for the requested application element .

Parameters:

aid - The Id of the application element.

Returns:

The access control list entries of the given application element for the initial rights.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInstanceInitialRights

InitialRight[] getInstanceInitialRights(T_LONGLONG aid,
                                      T_LONGLONG iid)
                                        throws AoException

(24019) Retrieve access control list information of the initial rights for the requested instance /.

Parameters:

aid - The Id of the application element.

iid - The Id of the instance.

Returns:

The access control list entries of the given instance for the initial rights.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInstancesExt

ResultSetExt[] getInstancesExt(QueryStructureExt aoq,
                             int how_many)
                               throws AoException

(24020) Perform the Query. This method can be used for a more powerful query compared to the method getInstances of this interface, with join definitions and aggregate functions. The number of different application elements which are requested are exactly defined by the definition of the query given in the field anuSeq of the QueryStructureExt. The number of attributes for each application element is also given in the definition. The number of matching instances (their attributes) is not defined by the query and can be a large amount. Therefore only one iterator for the attribute values is defined. The return is a sequence of the structure ResultSetExt . This sequence will always have the length of 1. This element in the structure has two fields - firstElems of type ElemResultSetExtSequence - restElems of type ElemResultSetExtSeqIterator firstElems The firstElems is a sequence of ElemResultSetExt, the length of the sequence corresponds with the number of different application elements requested in the anuSeq of the QueryStructrueExt. The structure ElemResultSetExt has the fields aid and values. The aid is the Id of the application element, the values, a sequence of the structure NameValueSeqUnitId are the values of the attributes. For each reported attribute an entry is given in the sequence, the name of the attribute is given in the field valName. The Id of the unit is given in the field unitId, this is the Id of the instance of the application element derived from the base element AoUnit. The values are given in the field value with the type TS_ValueSeq. Each value sequence has the same length, this length is less or equal to maximum how_many (the parameter of the method). If no values are found the length of the sequence is 0. The values with the same index in the different sequences of the entry in the NameValueSeqUnitIdSequence belong to the same instance element. restElems The restElems is an iterator for the remaining sequence of ElemResultSetExt. This iterator allows to load the next N values from the ResultSet. The result of the element is stored the same way as at the firstElems, the next N is the length of the sequence of the field value of the NameValueSeqUnitId. The method nextOne is wrong specified and should not be used, use instead the method nextN with n=1. The method getCount returns the total number of elements found, the number already returned in firstElems. The method reset set the iterator the beginning of the ResultSet, this is the beginning of the firstElems. The values of the localcolumn instances are part of the resultset when the following criteria all fit: - Only when the attributes id, generation_parameters, values, flags are requested, as soon as any other attributes is requested the values are not reported. - The values of the localcolumn must all belong to exactly one instances of AoMeasurement - The server have a limitation of the memory, not the system memory limitation, as soon as the result set will break the limitation an exception will be thrown. - No iterator for the rest is required. In case an attribute of blob type is among the requested attributes, the content of the return structure will depend on the number of instances that are returned: - In case attributes of only one instance are returned (either because 'how_many' was set to 1 or there is only one instance available at the server), the return structure contains the blob itself. - In case attributes of more than one instance are returned, the return structure does not contain the blobs; instead it contains the headers of the respective blobs. The value of valName of query result values shall be the aaName in case AggrFunc='NONE' and shall be constructed for all other AggrFunc values as string concatenation of the AggrFunc value followed by a '(' character, followed by the name of attribute (aaName) followed by a ')' character.

Parameters:

aoq - The query definition.

how_many - Maximum number of values in each result set. Valid arguments are: how_many = 0 : report all found values, how_many > 0 : report a maximum number of values.

Returns:

The result set with the requested attribute values.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getValueMatrixInMode

ValueMatrix getValueMatrixInMode(ElemId elem,
                               ValueMatrixMode vmMode)
                                 throws AoException

(24021) Get the value matrix of a measurement or a submatrix. If the value matrix will be built up with special submatrix link, use the interface Measurement. The behavior of the ASAM ODS server depends on whether the referenced element is a submatrix or a measurement. For more information on the server behavior see description at the method getValueMatrixInMode() of the interfaces 'Measurement' and 'SubMatrix'.

Parameters:

elem - The element id. The aid has to be the application element Id of the AoMeasurement or AoSubmatrix.

vmMode - The requested mode of the value matrix.

Returns:

The value matrix.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_INVALID_BASETYPE AO_INVALID_VALUEMATRIX_STRUCTURE

getODSFile

ODSFile getODSFile(ElemId elem)
                   throws AoException

(24022) Get the ODSFile interface for an instance of an application element derived from AoFile. This method returns an ODSFile interface. One parameter controls the behavior of this method: The value of the parameter 'elem' (with its components 'aid' and 'iid') uniquely identifies an instance within the ODS storage. If no such instance exists, or if the instance is not an instance of an application element derived from AoFile, the exception AO_INVALID_BASETYPE is thrown. Note that an ODS server may be set up to support the ODS security concepts and that in such case access to a file is only allowed if the access rights of the accessing user are sufficient. If the user does not have at least READ rights for the instance specified by 'elem' an exception AO_ACCESS_DENIED will be thrown.

Parameters:

elem - The instance to which the file belongs, whose access is intended.

Returns:

The ODSFile interface to access the desired file.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_INVALID_BASETYPE AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_ACCESS_DENIED