DataCommonProtocolUse DataCommonProtocolServices

Usage: you must use this class as is. You should never derive it.

public class DataCommonProtocolServices

Generic services that operate on all objets implementing CATIUseEntity interface.
For more specific details, please refer to the documentation of each entity.

See also:

Method Index

o CanDelete(CATIUseEntity*,CATBoolean&)

Returns the deletable status of an entity.

o Delete(CATIUseEntity*)

Deletes an entity.

o IsUpToDate(CATIUseEntity*,CATBoolean&)

Returns the update status of an entity.

o Update(CATIUseEntity*)

Updates an entity.

Methods

Returns the deletable status of an entity.

Parameters:

iEntity

the object to consider.

oDeletable

the computed or retrieved deletable status.

Returns:

• S_OK: the deletable status has been computed or retrieved sucessfully and been stored in oDeletable parameter.
• E_POINTER: input parameter iEntity is null or invalid.
• E_NOTIMPL: there is no deletion aspect implemented on the provided object.
• E_FAIL: the operation could not be completed.
  More information may be available via CATError::CATGetLastError.

Deletes an entity. This service will first call the CanDelete service.
Depending on the result, the following action(s) will be taken:

• (S_OK, oDeletable == TRUE): invoke actual deletion code, return deletion return code.
• (S_OK, oDeletable == FALSE): return E_ACCESSDENIED (deletion code is NOT invoked).
• E_POINTER: return E_POINTER (deletion code is NOT invoked).
• E_NOTIMPL: invoke actual deletion code, return deletion return code.
• E_FAIL: return E_UNEXPECTED (deletion code is NOT invoked).
  More information may be available via CATError::CATGetLastError.

Parameters:

iEntity

the object to consider.

Returns:

• S_OK: the deletion was sucessful.
• E_ACCESSDENIED: the entity may not be deleted.
• E_UNEXPECTED: the entity failed to indicate whether it can be deleted or not.
• E_POINTER: input parameter iEntity is null or invalid.
• E_NOTIMPL: there is no deletion aspect implemented on the provided object.
• E_FAIL: the operation could not be completed.
  More information may be available via CATError::CATGetLastError.
  Warning: The model may be left modified after a failed call.

Returns the update status of an entity.

Parameters:

iEntity

the object to consider.

oUpToDate

the computed or retrieved update status.

Returns:

• S_OK: the update status has been computed or retrieved sucessfully and been stored in oUpToDate parameter.
• E_POINTER: input parameter iEntity is null or invalid.
• E_NOTIMPL: there is no update aspect implemented on the provided object.
• E_FAIL: the operation could not be completed.
  More information may be available via CATError::CATGetLastError.

Updates an entity. This service will first call the IsUpToDate service.
Depending on the result, the following action(s) will be taken:

• (S_OK, oUpToDate == FALSE): invoke actual update code, return update return code.
• (S_OK, oUpToDate == TRUE): return S_FALSE (update code is NOT invoked).
• E_POINTER: return E_POINTER (update code is NOT invoked).
• E_NOTIMPL: return E_NOTIMPL (update code is NOT invoked).
• E_FAIL: return E_UNEXPECTED (update code is NOT invoked).
  More information may be available via CATError::CATGetLastError.

Parameters:

iEntity

the object to consider.

Returns:

• S_OK: the update was sucessful.
• E_POINTER: input parameter iEntity is null or invalid.
• E_NOTIMPL: there is no update aspect implemented on the provided object.
• E_FAIL: the operation could not be completed.
  More information may be available via CATError::CATGetLastError.
  Warning: The model may be left modified after a failed call.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.