Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSSource11 Interface Reference

Inherits IDSSSource10.

Inherited by IDSSSource12.

List of all members.

Public Member Functions

HRESULT FlagObject ([in] BSTR iObjectID,[in] EnumDSSObjectType iType,[in] BSTR iFlagID,[in] IDSSUserRuntime *ipUserRuntime)
 FlagObject flags single object with existing flag.
HRESULT FlagObjects ([in] IDSSCollection *ipObjectCollection,[in] BSTR iFlagID,[in] IDSSUserRuntime *ipUserRuntime)
 FlagObjects flags multiple objects with the same flag in batch.
HRESULT GetFlaggedObjects ([in] BSTR iFlagID,[out, retval] IDSSFolder oppSearchFolder)
 GetFlaggedObjects retrieves all the Objects that have been tagged by the flag.
HRESULT GetFlags ([in] BSTR iObjectID,[in] EnumDSSObjectType iType,[out, retval] IDSSFolder oppSearchFolder)
 GetFlags retrieves all the flags that have tagged the object.
HRESULT UnFlagObject ([in] BSTR iObjectID,[in] EnumDSSObjectType iType,[in] BSTR iFlagID,[in] IDSSUserRuntime *ipUserRuntime)
 UnFlagObject undo-flags single object with existing flag.
HRESULT UnFlagObjects ([in] IDSSCollection *ipObjectCollection,[in] BSTR iFlagID,[in] IDSSUserRuntime *ipUserRuntime)
 UnFlagObjects undo-flags multiple objects with the same flag in batch.

Member Function Documentation

HRESULT IDSSSource11::FlagObject (  [in] BSTR  iObjectID,
[in] EnumDSSObjectType  iType,
[in] BSTR  iFlagID,
[in] IDSSUserRuntime *  ipUserRuntime
) 
 

FlagObject flags single object with existing flag.

It is implemented by setting up LinkItem for the Link according to the ObjectSource, say Configuration Tagging Link/Project Tagging Link if the ObjectSource is Configuration/Project Level. The LinkItem overwrites the old one even if the LinkItem has already been established between the object and flag, the LinkItem is saved immediately to the metadata database. The object to be tagged is arbitrary first class object that can be implied by DSSTypeGeneric, may NOT be DSSTypeFlag itself.

Parameters:
iObjectID The object ID of the object which is to be flagged.
iType The object type of the object which is to be flagged.
iFlagID The flag object ID of the flag that FlagObject uses to tag other object.
ipUserRuntime The user performing this operation.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSSource11::FlagObjects (  [in] IDSSCollection *  ipObjectCollection,
[in] BSTR  iFlagID,
[in] IDSSUserRuntime *  ipUserRuntime
) 
 

FlagObjects flags multiple objects with the same flag in batch.

It is implemented by setting up LinkItem for the Link according to the ObjectSource, say Configuration Tagging Link/Project Tagging Link if the ObjectSource is Configuration/Project Level. The LinkItem overwrites the old one even if the LinkItem has already been established between the object and flag, the LinkItem is saved immediately to the metadata database. The objects in the collection are not necessarily the same type, objects are retrieved and flagged one by one from the collection, the object to be tagged is arbitrary first class object that can be implied by DSSTypeGeneric, may NOT be DSSTypeFlag itself.

Parameters:
ipObjectCollection The collection of the objects which are to be flagged.
iFlagID The flag object ID of the flag that FlagObject uses to tag other objects.
ipUserRuntime The user performing this operation.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSSource11::GetFlaggedObjects (  [in] BSTR  iFlagID,
[out, retval] IDSSFolder   oppSearchFolder
) 
 

GetFlaggedObjects retrieves all the Objects that have been tagged by the flag.

One flag could tag one or more objects in the same object source, all the flagged objects in the same object source could be returned.

Parameters:
iFlagID The flag object ID of the flag that GetFlaggedObjects retrieves all the objects have been tagged with.
oppSearchFolder The IDSSFolder conains the result of search.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSSource11::GetFlags (  [in] BSTR  iObjectID,
[in] EnumDSSObjectType  iType,
[out, retval] IDSSFolder   oppSearchFolder
) 
 

GetFlags retrieves all the flags that have tagged the object.

One object could be tagged by multiple flags in the same object source, all the flags in the same object source could be returned.

Parameters:
iObjectID The object ID of the Object that GetFlags retrieves all the flags have tagged.
iType The object type of the Object that GetFlags retrieves all the flags have tagged.
oppSearchFolder The IDSSFolder conains the result of search.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSSource11::UnFlagObject (  [in] BSTR  iObjectID,
[in] EnumDSSObjectType  iType,
[in] BSTR  iFlagID,
[in] IDSSUserRuntime *  ipUserRuntime
) 
 

UnFlagObject undo-flags single object with existing flag.

It is implemented by removing LinkItem for the Link according to the ObjectSource, say Configuration Tagging Link/Project Tagging Link if the ObjectSource is Configuration/Project Level. The LinkItem property is set to "Not Exist" no matter the LinkItem has already been established between the object and flag or not, the LinkItem is saved immediately to the metadata database. The object to be undo-tagged is arbitrary first class object that can be implied by DSSTypeGeneric, may NOT be DSSTypeFlag itself.

Parameters:
iObjectID The object ID of the object which is to be undo-flagged.
iType The object type of the object which is to be undo-flagged.
iFlagID The flag object ID of the flag that UnFlagObject uses to undo-tag other object.
ipUserRuntime The user performing this operation.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSSource11::UnFlagObjects (  [in] IDSSCollection *  ipObjectCollection,
[in] BSTR  iFlagID,
[in] IDSSUserRuntime *  ipUserRuntime
) 
 

UnFlagObjects undo-flags multiple objects with the same flag in batch.

It is implemented by removing LinkItem for the Link according to the ObjectSource, say Configuration Tagging Link/Project Tagging Link if the ObjectSource is Configuration/Project Level. The LinkItem property is set to "Not Exist" no matter the LinkItem has already been established between the object and flag or not, the LinkItem is saved immediately to the metadata database. The objects in the collection are not necessarily the same type, objects are retrieved and undo-flagged one by one from the collection, the object to be undo-tagged is arbitrary first class object that can be implied by DSSTypeGeneric, may NOT be DSSTypeFlag itself.

Parameters:
ipObjectCollection The collection of the objects which are to be undo-flagged.
iFlagID The flag object ID of the flag that FlagObject uses to undo-tag other objects.
ipUserRuntime The user performing this operation.
Returns:
Usual COM result code:
  • S_OK

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.