All Frameworks Class Hierarchy This Framework Indexes
VPMInterfaces Interface CATIVpmAttribute
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVpmAttribute
This interface is implemented by all persistent ENOVIA objects, and provides means to read/write (non multi-valuated) attribute values.
Method Index
- o
AutomaticTSMode()
- Automatical managing of time stamp.
- o
CheckAttribute(CATUnicodeString&,VPMCA&)
- Verify the attribut on the VPMObject.
- o
CloneMe(CATIVpmFactoryObject_var&,CATListOfVPMCA&)
- Clone a VPMObject and assign a list of attributes.
- o
CloneMe(CATListOfVPMCA&,CATIVpmFactoryObject_var&)
- Clone a VPMObject.
- o
DoesBlobExist(CATUnicodeString&)
- To know if a Blob exists.
- o
GetAttributeName(CATUnicodeString&,AccessControl&,VPMCA&)
- Access to an attribute.
- o
GetAttributeNames(CATListOfVPMCA&,AccessControl&)
- Access to an attribute.
- o
GetBlob(CATUnicodeString&,SEQUENCE(octet)&)
- Retrieve the value from an existing blob.
- o
GetIdentifier(CORBAAny&)
- Get the VPMObject UUID.
- o
GetListOfBlob(CATListOfCATUnicodeString&)
- Retrieve names of existing blobs.
- o
GetMaxValue(CATUnicodeString&,CORBAAny&)
- Compute the maximal value.
- o
GetMinValue(CATUnicodeString&,CORBAAny&)
- Compute the minimal value.
- o
GetValue(CATUnicodeString&,CORBAAny&)
- Get a Simple Value.
- o
IsChanged()
- Check the modification Values.
- o
IsPersistent()
- Is the object persistent.
- o
NoTSMode()
- No automatical managing of time stamp.
- o
RefreshValues()
- Check the modification Values.
- o
RemoveBlob(CATUnicodeString&)
- Remove an existing blob.
- o
Reset()
- Reset an object.
- o
SetBlob(CATUnicodeString&,SEQUENCE(octet)&,boolean)
- Valuate or create a new Blob.
- o
SetPersistencyFlag()
- Set persistency flag.
- o
SetValue(CATUnicodeString&,CORBAAny&)
- Set a Simple Value.
- o
UnsetPersistencyFlag()
- Unset persistency flag.
- o
UnsetValue(CATUnicodeString&)
- Unset a Simple Value.
Methods
o AutomaticTSMode
| public virtual AutomaticTSMode( | ) |
-
Automatical managing of time stamp.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Time Stamp is automaticaly modified
- E_FAIL
- An error occured during the process
o CheckAttribute
| public virtual CheckAttribute( | const | iAttributeName, |
| | oVPMCA) |
-
Verify the attribut on the VPMObject.
- Parameters:
-
- iAttributeName
- The name of attribute.
- oVPMCA
- The checked attribute.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute exists
- S_FALSE
- The attribute does not exist
- E_FAIL
- An error occured during the process
o CloneMe
| public virtual CloneMe( | const | iMyClone, |
| | iVPMCAList) |
-
Clone a VPMObject and assign a list of attributes.
- Parameters:
-
- iMyClone
- The clone.
- iVPMCAList
- List of attributes.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Clone OK
- E_FAIL
- An error occured during the process
o CloneMe
| public virtual CloneMe( | | iVPMCAList, |
| | oMyClone) |
-
Clone a VPMObject.
- Parameters:
-
- iVPMCAList
- List of attributes.
- oMyClone
- The clone.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Clone OK
- E_FAIL
- An error occured during the process
o DoesBlobExist
| public virtual DoesBlobExist( | const | iBlobName) |
-
To know if a Blob exists.
- Parameters:
-
- iBlobName
- The name of the blob.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The blob was found
- S_FALSE
- The blob was not found
- E_FAIL
- An error occured during the process
o GetAttributeName
| public virtual GetAttributeName( | const | iAttributeName, |
| const | iAccessControl, |
| | oVPMCA) |
-
Access to an attribute.
- Parameters:
-
- iAttributeName
- The name of the attribute.
- iAccessControl
- .
- oVPMCA
- The definition found.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Definition OK
- E_FAIL
- An error occured during the process
o GetAttributeNames
| public virtual GetAttributeNames( | | oVPMCAList, |
| const | iAccessControl) |
-
Access to an attribute.
- Parameters:
-
- oVPMCAList
- List of definitions found.
- iAccessControl
- .
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Definitions OK
- E_FAIL
- An error occured during the process
o GetBlob
| public virtual GetBlob( | const | iBlobName, |
| | oValue) |
-
Retrieve the value from an existing blob.
- Parameters:
-
- iBlobName
- The name of the blob.
- oValue
- The value found in it.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The blob was found
- S_FALSE
- The blob was not found
- E_FAIL
- An error occured during the process
o GetIdentifier
| public virtual GetIdentifier( | | oUUID) |
-
Get the VPMObject UUID.
- Parameters:
-
- oUUID
- The uuid found.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- UUID OK
- E_FAIL
- An error occured during the process
o GetListOfBlob
| public virtual GetListOfBlob( | | oListOfBlob) |
-
Retrieve names of existing blobs.
- Parameters:
-
- oListOfBlob
- The list of blobs found.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The list was found
- E_FAIL
- An error occured during the process
o GetMaxValue
| public virtual GetMaxValue( | const | iAttributeName, |
| | oMaxValue) |
-
Compute the maximal value.
- Parameters:
-
- iAttributeName
- The name of attribute.
- oMaxValue
- The computed maximal value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute has been computed
- E_FAIL
- An error occured during the process
o GetMinValue
| public virtual GetMinValue( | const | iAttributeName, |
| | oMinValues) |
-
Compute the minimal value.
- Parameters:
-
- iAttributeName
- The name of attribute.
- oMinValues
- The computed minimal value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute has been computed
- E_FAIL
- An error occured during the process
o GetValue
| public virtual GetValue( | const | iAttributeName, |
| | oValue) |
-
Get a Simple Value.
- Parameters:
-
- iAttributeName
- The name of attribute.
- oValue
- The value found.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute is valuated
- S_FALSE
- The attribute is not valuated
- E_FAIL
- An error occured during the process or the attribute does not exist
o IsChanged
| public virtual IsChanged( | ) |
-
Check the modification Values.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- VPMObject is modified
- S_FALSE
- VPMObject is not modified
- E_FAIL
- An error occured during the process
o IsPersistent
| public virtual IsPersistent( | ) |
-
Is the object persistent.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is persistent
- S_FALSE
- The object is volatile
o NoTSMode
| public virtual NoTSMode( | ) |
-
No automatical managing of time stamp.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- User has to modify TS explicitely
- E_FAIL
- An error occured during the process
o RefreshValues
| public virtual RefreshValues( | ) |
-
Check the modification Values.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Refresh OK
- E_FAIL
- An error occured during the process
o RemoveBlob
| public virtual RemoveBlob( | const | iBlobName) |
-
Remove an existing blob.
- Parameters:
-
- iBlobName
- The name of the blob.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The blob was found and removed
- S_FALSE
- The blob was not found
- E_FAIL
- An error occured during the process
o Reset
-
Reset an object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is no more modified
- E_FAIL
- An error occured during the process
o SetBlob
| public virtual SetBlob( | const | iBlobName, |
| const | iValue, |
| | iclone | =TRUE) |
-
Valuate or create a new Blob.
- Parameters:
-
- iBlobName
- The name of the blob.
- iValue
- The value to put in it.
- iclone
- Define if the blob must be duplicated when the object is duplicated.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The blob is modified or created
- E_FAIL
- An error occured during the process
o SetPersistencyFlag
| public virtual SetPersistencyFlag( | ) |
-
Set persistency flag.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is candidate to the persistence
- E_FAIL
- An error occured during the process
o SetValue
| public virtual SetValue( | const | iAttributeName, |
| const | iValue) |
-
Set a Simple Value.
- Parameters:
-
- iAttributeName
- The name of attribute.
- iValue
- The new value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute is modified
- S_FALSE
- Impossible to modify this attribute
- E_FAIL
- An error occured during the process or the attribute does not exist
o UnsetPersistencyFlag
| public virtual UnsetPersistencyFlag( | ) |
-
Unset persistency flag.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is not candidate to the persistence
- E_FAIL
- An error occured during the process
o UnsetValue
| public virtual UnsetValue( | const | iAttributeName) |
-
Unset a Simple Value.
- Parameters:
-
- iAttributeName
- The name of attribute.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute is modified
- S_FALSE
- Impossible to modify this attribute
- E_FAIL
- An error occured during the process or the attribute does not exist
This object is included in the file: CATIVpmAttribute.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces