Mobile API Reference  MicroStrategy 2019
DSSObjectInfo Class Reference

#include <DSSObjectInfo.h>

Inheritance diagram for DSSObjectInfo:
DSSAttribute DSSAttribute DSSAttributeForm DSSAttributeForm DSSConsolidation DSSConsolidation DSSConsolidationElement DSSConsolidationElement DSSCustomGroup DSSCustomGroup DSSDimension DSSDimension DSSDocumentDefinition DSSDocumentDefinition DSSFilter DSSFilter DSSFormat DSSFormat DSSFunction DSSFunction DSSMetric DSSMetric DSSReportDefinition DSSReportDefinition DSSTemplate DSSTemplate

Public Member Functions

 DSSObjectInfo ()
 
virtual ~DSSObjectInfo ()
 
 DSSObjectInfo (GUID &iID, GUID &iOnwerID, DSSObjectContext *iObjectContext, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
 DSSObjectInfo (GUID &iID, EnumDSSObjectType iType, std::string iName, DSSObjectContext *iObjectContext, GUID iContainerID=GUID_NULL, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
GUID getID ()
 
EnumDSSObjectType getType ()
 
std::string getName ()
 
std::string & getNameRef ()
 
void setName (std::string iName)
 
void setDsc (std::string iDsc)
 
std::string getDsc ()
 
GUID getContainerID ()
 
DSSObjectContext * getObjectContext ()
 
int LoadPropertiesFromBinary (DSSBinaryDataReader *ipReader)
 
void InsertPropertySet (std::string iPropertySetName, DSSPropertySetBaseClass *ipPropertySet)
 
CComVariant * getPropertyValue (std::string iPropertySetName, std::string iPropertyName)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, std::string iPropertyValue)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, CComVariant &iPropertyValue)
 
virtual void MakeCleanDefn ()
 
PropertySetsMap getPropertySetsMap ()
 
GUID getOnwerID ()
 
void putOwnerID (GUID &iOnwerID)
 
void addACE (GUID &iTrusteeID, int iTypeAndRights)
 
bool CheckAccess (DSSUserRuntime *ipUserRuntime, int iDesiredAccess, bool iRequireAll=true)
 
EnumDSSViewMedia getViewMedia ()
 
std::vector< DSSAccessControlEntry > getACL ()
 
void Duplicate (DSSObjectInfo *ipObjectInfo)
 
 DSSObjectInfo ()
 
virtual ~DSSObjectInfo ()
 
 DSSObjectInfo (GUID &iID, GUID &iOnwerID, DSSObjectContext *iObjectContext, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
 DSSObjectInfo (GUID &iID, EnumDSSObjectType iType, std::string iName, DSSObjectContext *iObjectContext, GUID iContainerID=GUID_NULL, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
GUID getID ()
 
EnumDSSObjectType getType ()
 
std::string getName ()
 
std::string & getNameRef ()
 
void setName (std::string iName)
 
void setDsc (std::string iDsc)
 
std::string getDsc ()
 
GUID getContainerID ()
 
DSSObjectContext * getObjectContext ()
 
int LoadPropertiesFromBinary (DSSBinaryDataReader *ipReader)
 
void InsertPropertySet (std::string iPropertySetName, DSSPropertySetBaseClass *ipPropertySet)
 
CComVariant * getPropertyValue (std::string iPropertySetName, std::string iPropertyName)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, std::string iPropertyValue)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, CComVariant &iPropertyValue)
 
virtual void MakeCleanDefn ()
 
PropertySetsMap getPropertySetsMap ()
 
GUID getOnwerID ()
 
void putOwnerID (GUID &iOnwerID)
 
void addACE (GUID &iTrusteeID, int iTypeAndRights)
 
bool CheckAccess (DSSUserRuntime *ipUserRuntime, int iDesiredAccess, bool iRequireAll=true)
 
EnumDSSViewMedia getViewMedia ()
 
std::vector< DSSAccessControlEntry > getACL ()
 
void Duplicate (DSSObjectInfo *ipObjectInfo)
 

Protected Attributes

EnumDSSObjectType mType
 
DSSObjectContext * mpObjectContext
 
PropertySetsMap mPropertySetsMap
 

Constructor & Destructor Documentation

◆ DSSObjectInfo() [1/6]

DSSObjectInfo::DSSObjectInfo ( )

◆ ~DSSObjectInfo() [1/2]

virtual DSSObjectInfo::~DSSObjectInfo ( )
virtual

◆ DSSObjectInfo() [2/6]

DSSObjectInfo::DSSObjectInfo ( GUID &  iID,
GUID &  iOnwerID,
DSSObjectContext *  iObjectContext,
EnumDSSViewMedia  iViewMedia = DssViewMediaReserved 
)

◆ DSSObjectInfo() [3/6]

DSSObjectInfo::DSSObjectInfo ( GUID &  iID,
EnumDSSObjectType  iType,
std::string  iName,
DSSObjectContext *  iObjectContext,
GUID  iContainerID = GUID_NULL,
EnumDSSViewMedia  iViewMedia = DssViewMediaReserved 
)

◆ DSSObjectInfo() [4/6]

DSSObjectInfo::DSSObjectInfo ( )

◆ ~DSSObjectInfo() [2/2]

virtual DSSObjectInfo::~DSSObjectInfo ( )
virtual

◆ DSSObjectInfo() [5/6]

DSSObjectInfo::DSSObjectInfo ( GUID &  iID,
GUID &  iOnwerID,
DSSObjectContext *  iObjectContext,
EnumDSSViewMedia  iViewMedia = DssViewMediaReserved 
)

◆ DSSObjectInfo() [6/6]

DSSObjectInfo::DSSObjectInfo ( GUID &  iID,
EnumDSSObjectType  iType,
std::string  iName,
DSSObjectContext *  iObjectContext,
GUID  iContainerID = GUID_NULL,
EnumDSSViewMedia  iViewMedia = DssViewMediaReserved 
)

Member Function Documentation

◆ addACE() [1/2]

void DSSObjectInfo::addACE ( GUID &  iTrusteeID,
int  iTypeAndRights 
)

◆ addACE() [2/2]

void DSSObjectInfo::addACE ( GUID &  iTrusteeID,
int  iTypeAndRights 
)

◆ CheckAccess() [1/2]

bool DSSObjectInfo::CheckAccess ( DSSUserRuntime *  ipUserRuntime,
int  iDesiredAccess,
bool  iRequireAll = true 
)

◆ CheckAccess() [2/2]

bool DSSObjectInfo::CheckAccess ( DSSUserRuntime *  ipUserRuntime,
int  iDesiredAccess,
bool  iRequireAll = true 
)

◆ Duplicate() [1/2]

void DSSObjectInfo::Duplicate ( DSSObjectInfo *  ipObjectInfo)

◆ Duplicate() [2/2]

void DSSObjectInfo::Duplicate ( DSSObjectInfo *  ipObjectInfo)

◆ getACL() [1/2]

std::vector<DSSAccessControlEntry> DSSObjectInfo::getACL ( )

◆ getACL() [2/2]

std::vector<DSSAccessControlEntry> DSSObjectInfo::getACL ( )

◆ getContainerID() [1/2]

GUID DSSObjectInfo::getContainerID ( )

◆ getContainerID() [2/2]

GUID DSSObjectInfo::getContainerID ( )

◆ getDsc() [1/2]

std::string DSSObjectInfo::getDsc ( )

◆ getDsc() [2/2]

std::string DSSObjectInfo::getDsc ( )

◆ getID() [1/2]

GUID DSSObjectInfo::getID ( )

◆ getID() [2/2]

GUID DSSObjectInfo::getID ( )

◆ getName() [1/2]

std::string DSSObjectInfo::getName ( )

◆ getName() [2/2]

std::string DSSObjectInfo::getName ( )

◆ getNameRef() [1/2]

std::string& DSSObjectInfo::getNameRef ( )

◆ getNameRef() [2/2]

std::string& DSSObjectInfo::getNameRef ( )

◆ getObjectContext() [1/2]

DSSObjectContext* DSSObjectInfo::getObjectContext ( )

◆ getObjectContext() [2/2]

DSSObjectContext* DSSObjectInfo::getObjectContext ( )

◆ getOnwerID() [1/2]

GUID DSSObjectInfo::getOnwerID ( )

◆ getOnwerID() [2/2]

GUID DSSObjectInfo::getOnwerID ( )

◆ getPropertySetsMap() [1/2]

PropertySetsMap DSSObjectInfo::getPropertySetsMap ( )
inline

◆ getPropertySetsMap() [2/2]

PropertySetsMap DSSObjectInfo::getPropertySetsMap ( )

◆ getPropertyValue() [1/2]

CComVariant* DSSObjectInfo::getPropertyValue ( std::string  iPropertySetName,
std::string  iPropertyName 
)

◆ getPropertyValue() [2/2]

CComVariant* DSSObjectInfo::getPropertyValue ( std::string  iPropertySetName,
std::string  iPropertyName 
)

◆ getType() [1/2]

EnumDSSObjectType DSSObjectInfo::getType ( )

◆ getType() [2/2]

EnumDSSObjectType DSSObjectInfo::getType ( )

◆ getViewMedia() [1/2]

EnumDSSViewMedia DSSObjectInfo::getViewMedia ( )

◆ getViewMedia() [2/2]

EnumDSSViewMedia DSSObjectInfo::getViewMedia ( )

◆ InsertPropertySet() [1/2]

void DSSObjectInfo::InsertPropertySet ( std::string  iPropertySetName,
DSSPropertySetBaseClass *  ipPropertySet 
)

◆ InsertPropertySet() [2/2]

void DSSObjectInfo::InsertPropertySet ( std::string  iPropertySetName,
DSSPropertySetBaseClass *  ipPropertySet 
)

◆ LoadPropertiesFromBinary() [1/2]

int DSSObjectInfo::LoadPropertiesFromBinary ( DSSBinaryDataReader *  ipReader)

◆ LoadPropertiesFromBinary() [2/2]

int DSSObjectInfo::LoadPropertiesFromBinary ( DSSBinaryDataReader *  ipReader)

◆ MakeCleanDefn() [1/2]

◆ MakeCleanDefn() [2/2]

◆ putOwnerID() [1/2]

void DSSObjectInfo::putOwnerID ( GUID &  iOnwerID)

◆ putOwnerID() [2/2]

void DSSObjectInfo::putOwnerID ( GUID &  iOnwerID)

◆ setDsc() [1/2]

void DSSObjectInfo::setDsc ( std::string  iDsc)

◆ setDsc() [2/2]

void DSSObjectInfo::setDsc ( std::string  iDsc)

◆ setName() [1/2]

void DSSObjectInfo::setName ( std::string  iName)

◆ setName() [2/2]

void DSSObjectInfo::setName ( std::string  iName)

◆ setPropertyValue() [1/4]

void DSSObjectInfo::setPropertyValue ( std::string  iPropertySetName,
std::string  iPropertyName,
std::string  iPropertyValue 
)

◆ setPropertyValue() [2/4]

void DSSObjectInfo::setPropertyValue ( std::string  iPropertySetName,
std::string  iPropertyName,
std::string  iPropertyValue 
)

◆ setPropertyValue() [3/4]

void DSSObjectInfo::setPropertyValue ( std::string  iPropertySetName,
std::string  iPropertyName,
CComVariant &  iPropertyValue 
)

◆ setPropertyValue() [4/4]

void DSSObjectInfo::setPropertyValue ( std::string  iPropertySetName,
std::string  iPropertyName,
CComVariant &  iPropertyValue 
)

Member Data Documentation

◆ mpObjectContext

DSSObjectContext * DSSObjectInfo::mpObjectContext
protected

◆ mPropertySetsMap

PropertySetsMap DSSObjectInfo::mPropertySetsMap
protected

◆ mType

EnumDSSObjectType DSSObjectInfo::mType
protected

The map from propertyset name to DSSPropertySet