CDRMRightsConstraints Class Reference

class CDRMRightsConstraints : public CBase

CDRMRightsConstraints : Encapsulates rights constaints for a specific right.

DrmRights.dll
Since
2.5

Inherits from

Public Member Functions
~CDRMRightsConstraints (void)
IMPORT_C TBool FullRights (void)
IMPORT_C TInt GetAccumulated ( TTimeIntervalSeconds &)
IMPORT_C CDRMConstraint & GetConstraint (void)
IMPORT_C TInt GetConstraintInfo ( TUint32 &, TUint32 &)
IMPORT_C TInt GetCounters ( TUint32 &, TUint32 &)
IMPORT_C TInt GetEndTime ( TTime &)
IMPORT_C TInt GetExpirationDetails ( TTime &, TInt &)
IMPORT_C TInt GetInterval ( TTimeIntervalSeconds &)
IMPORT_C TInt GetIntervalStart ( TTime &)
IMPORT_C TInt GetStartTime ( TTime &)
IMPORT_C TInt GetTimedCounters ( TUint32 &, TUint32 &)
IMPORT_C TBool IsPreview (void)
IMPORT_C CDRMRightsConstraints * NewL (void)
IMPORT_C void SetConstraint ( CDRMConstraint &)
IMPORT_C TInt SetCounters ( TUint32 , TUint32 )
IMPORT_C TInt SetEndTime ( TTime )
IMPORT_C TInt SetInterval ( TTimeIntervalSeconds )
IMPORT_C TInt SetIntervalStart ( TTime )
IMPORT_C TInt SetStartTime ( TTime )
IMPORT_C CDRMRightsConstraints & operator= ( CDRMRightsConstraints &)
Protected Member Functions
CDRMRightsConstraints (void)
IMPORT_C void ConstructL (void)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enum TConstraintPriority {
ENoConstraints  = 8, ETime  = 7, ETimeInterval  = 6, ETimeIntervalCount  = 5, ETimeCount  = 4, EInterval  = 3, EIntervalCount  = 2, ECount  = 1
}
Protected Attributes
CDRMConstraint * iConstraint

Constructor & Destructor Documentation

CDRMRightsConstraints(void)

IMPORT_C CDRMRightsConstraints ( void ) [protected]

Default constructor.

Parameters

void

~CDRMRightsConstraints(void)

IMPORT_C ~CDRMRightsConstraints ( void ) [virtual]

Destructor.

Parameters

void

Member Functions Documentation

ConstructL(void)

IMPORT_C void ConstructL ( void ) [protected]

2nd phase constructor.

Parameters

void

FullRights(void)

IMPORT_C TBool FullRights ( void )

FullRights

The FullRights function checks if the object contains any restrictions or if usage is unconstrained.

Since
2.5

Parameters

void

GetAccumulated(TTimeIntervalSeconds &)

IMPORT_C TInt GetAccumulated ( TTimeIntervalSeconds & anInterval )

GetAccumulated

This function returns accumulated time constraint

Since
3.0

Parameters

TTimeIntervalSeconds & anInterval

GetConstraint(void)

IMPORT_C CDRMConstraint & GetConstraint ( void )
Since
3.0

Parameters

void

GetConstraintInfo(TUint32 &, TUint32 &)

IMPORT_C TInt GetConstraintInfo ( TUint32 & aExpiration,
TUint32 & aConstType
)

GetConstraintInfo

The fucntion retunrs expiration and constraint details of the object

Since
2.5

Parameters

TUint32 & aExpiration
TUint32 & aConstType

GetCounters(TUint32 &, TUint32 &)

IMPORT_C TInt GetCounters ( TUint32 & aCounter,
TUint32 & aOriginalCounter
)

GetCounters

This function returns the current value of the count restriction and original value of the count restriction(value when the rights object was added to the rights database)

Since
2.5

Parameters

TUint32 & aCounter
TUint32 & aOriginalCounter

GetEndTime(TTime &)

IMPORT_C TInt GetEndTime ( TTime & aEndTime )

GetEndTime

This function returns the end time constraint.

Since
2.5

Parameters

TTime & aEndTime

GetExpirationDetails(TTime &, TInt &)

IMPORT_C TInt GetExpirationDetails ( TTime & aEndTime,
TInt & aCountsLeft
)

GetExpirationDetails

The function returns the end time and amount of counts left of the object.

Since
2.5

Parameters

TTime & aEndTime
TInt & aCountsLeft

GetInterval(TTimeIntervalSeconds &)

IMPORT_C TInt GetInterval ( TTimeIntervalSeconds & anInterval )

GetInterval

This function returns interval time constraint

Since
2.5

Parameters

TTimeIntervalSeconds & anInterval

GetIntervalStart(TTime &)

IMPORT_C TInt GetIntervalStart ( TTime & aStartTime )

GetIntervalStart

This function returns the start time of an activated interval

Since
2.5

Parameters

TTime & aStartTime

GetStartTime(TTime &)

IMPORT_C TInt GetStartTime ( TTime & aStartTime )

GetStartTime

This function returns the start time constraint.

Since
2.5

Parameters

TTime & aStartTime

GetTimedCounters(TUint32 &, TUint32 &)

IMPORT_C TInt GetTimedCounters ( TUint32 & aCounter,
TUint32 & aOriginalCounter
)

GetTimedCounters

This function returns the current value of the timed count restriction and original value of the count restriction(value when the rights object was added to the rights database)

Since
3.0

Parameters

TUint32 & aCounter
TUint32 & aOriginalCounter

IsPreview(void)

IMPORT_C TBool IsPreview ( void )

IsPreview

The function checks if the object represents a preview constraint.

Since
2.5

Parameters

void

NewL(void)

IMPORT_C CDRMRightsConstraints * NewL ( void ) [static]

Two-phased constructor.

Parameters

void

SetConstraint(CDRMConstraint &)

IMPORT_C void SetConstraint ( CDRMConstraint & )
Since
3.0

Parameters

CDRMConstraint &

SetCounters(TUint32, TUint32)

IMPORT_C TInt SetCounters ( TUint32 aCounter,
TUint32 aOriginalCounter
)

SetCounters

Sets the counter instance variables of the rights constraint

Since
2.5

Parameters

TUint32 aCounter
TUint32 aOriginalCounter

SetEndTime(TTime)

IMPORT_C TInt SetEndTime ( TTime aEndTime )

SetEndTime

Sets the end time constraint.

Since
2.5

Parameters

TTime aEndTime

SetInterval(TTimeIntervalSeconds)

IMPORT_C TInt SetInterval ( TTimeIntervalSeconds anInterval )

SetInterval

Sets the interval time constraint

Since
2.5

Parameters

TTimeIntervalSeconds anInterval

SetIntervalStart(TTime)

IMPORT_C TInt SetIntervalStart ( TTime aStartTime )

SetIntervalStart

Sets the interval start time constraint

Since
2.5

Parameters

TTime aStartTime

SetStartTime(TTime)

IMPORT_C TInt SetStartTime ( TTime aStartTime )

SetStartTime

Sets the start time constraint.

Since
2.5

Parameters

TTime aStartTime

operator=(CDRMRightsConstraints &)

IMPORT_C CDRMRightsConstraints & operator= ( CDRMRightsConstraints & aConstraint )

operator=

Assignment operator.

Since
2.5

Parameters

CDRMRightsConstraints & aConstraint

Member Enumerations Documentation

Enum TConstraintPriority

Enumerators

ENoConstraints = 8
ETime = 7
ETimeInterval = 6
ETimeIntervalCount = 5
ETimeCount = 4
EInterval = 3
EIntervalCount = 2
ECount = 1

Member Data Documentation

CDRMConstraint * iConstraint

CDRMConstraint * iConstraint [protected]