SFBvCalStore

Wrapper Class for the IvCalStore interface.

#include <SFBvCalStore.h.hpp>

class SFBvCalStore : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBvCalStore)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API IvCalStore

Member

Public Functions
`SFCError`	AddObject( `SFBvCalObjectSmpConstRef` calendar , `AEEVProperty *` propertyId ) Create/add a Event, Todo, Journal component record in the SFBvCalStore data store of type specified.
`SFCError`	DeleteObjectByOID( `AEEVProperty` propertyId ) Delete an object from the calendar data store based on the passed calendar record Object ID.
`SFCError`	GetObjectByOID( `AEEVProperty` propertyId , `SFBvCalObjectSmpPtr` calendar ) Retrieve the Event, Todo, Journal object given its OID.
`SFCError`	GetObjectOIDByUID( `ACharPtr` uid , `AEEVProperty *` propertyId ) Get the OID for a particular component type according to the specified UID string.
`SFCError`	GetObjectOIDs( `AEECLSID` id , `AEEVProperty *` propertyId , `SInt32` size , `SInt32Ptr` sizereq ) Get all the OIDs for a particular component type.
`SFCError`	IsCalendarLocked( `BoolPtr` locked ) Query whether the calendar is locked or unlocked.
`SFCError`	LockCalendar( `Void` ) Lock the calendar.
static `SFBvCalStoreSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBvCalStore instance.
static `SFBvCalStoreSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBvCalStore instance.
`SFCError`	OnAdd( `SFBSignalSmpConstRef` signal ) Get notifications for Add events on the calendar store.
`SFCError`	OnDelete( `SFBSignalSmpConstRef` signal ) Get notifications for delete events on the calendar store.
`SFCError`	OnLock( `SFBSignalSmpConstRef` signal ) Get notifications for Lock events on the calendar store.
`SFCError`	OnUpdate( `SFBSignalSmpConstRef` signal ) Get notifications for Update events on the calendar store.
`SFCError`	UnlockCalendar( `Void` ) Unlock the calendar.
`SFCError`	UpdateObject( `SFBvCalObjectSmpConstRef` calendar ) Update a calendar Record in the IvCalStore data store of type specified.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBvCalStore::AddObject

Create/add a Event, Todo, Journal component record in the SFBvCalStore data store of type specified.

[ public ]
SFCError AddObject(
    SFBvCalObjectSmpConstRef calendar   // smart pointer to an object to be saved
    AEEVProperty * propertyId           // the returned OID of record added
);

Reference

BREW API IvCalStore_AddObject

SFBvCalStore::DeleteObjectByOID

Delete an object from the calendar data store based on the passed calendar record Object ID.

[ public ]
SFCError DeleteObjectByOID(
    AEEVProperty propertyId   // the IvCalStore object ID to be deleted
);

Reference

BREW API IvCalStore_DeleteObjectByOID

SFBvCalStore::GetObjectByOID

Retrieve the Event, Todo, Journal object given its OID.

[ public ]
SFCError GetObjectByOID(
    AEEVProperty propertyId        // the IvCalStore Object ID to be retrieved
    SFBvCalObjectSmpPtr calendar   // holds pointer to the returned object
);

Reference

BREW API IvCalStore_GetObjectByOID

SFBvCalStore::GetObjectOIDByUID

Get the OID for a particular component type according to the specified UID string.

[ public ]
SFCError GetObjectOIDByUID(
    ACharPtr uid                // character string for UID in a calendar
    AEEVProperty * propertyId   // object ID for this UID
);

Reference

BREW API IvCalStore_GetObjectOIDByUID

SFBvCalStore::GetObjectOIDs

Get all the OIDs for a particular component type.

[ public ]
SFCError GetObjectOIDs(
    AEECLSID id                 // object type
    AEEVProperty * propertyId   // list of OIDs returned
    SInt32 size                 // size of the list
    SInt32Ptr sizereq           // on return will contain the required number of the elements (OIDs)
);

Reference

BREW API IvCalStore_GetObjectOIDs

SFBvCalStore::IsCalendarLocked

Query whether the calendar is locked or unlocked.

[ public ]
SFCError IsCalendarLocked(
    BoolPtr locked   // true if calendar locked, false if not locked.
);

Reference

BREW API IvCalStore_IsCalendarLocked

SFBvCalStore::LockCalendar

Lock the calendar.

[ public ]
SFCError LockCalendar(Void);

Reference

BREW API IvCalStore_LockCalendar

SFBvCalStore::NewInstance

Create a new SFBvCalStore instance.

[ public, static ]
SFBvCalStoreSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBvCalStoreSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBvCalStore::OnAdd

Get notifications for Add events on the calendar store.

[ public ]
SFCError OnAdd(
    SFBSignalSmpConstRef signal   // smart pointer to SFBSignal object that's set when a new object has been added in the database
);

Reference

BREW API IvCalStore_OnAdd | SFBSignal

SFBvCalStore::OnDelete

Get notifications for delete events on the calendar store.

[ public ]
SFCError OnDelete(
    SFBSignalSmpConstRef signal   // smart pointer to the SFBSignal object that's set when any object in the database is deleted
);

Reference

BREW API IvCalStore_OnDelete

SFBvCalStore::OnLock

Get notifications for Lock events on the calendar store.

[ public ]
SFCError OnLock(
    SFBSignalSmpConstRef signal   // smart pointer to the SFBSignal object that's set when the database is locked
);

Reference

BREW API IvCalStore_OnLock

SFBvCalStore::OnUpdate

Get notifications for Update events on the calendar store.

[ public ]
SFCError OnUpdate(
    SFBSignalSmpConstRef signal   // smart pointer to the SFBSignal object that's set when any object in the database is updated
);

Reference

BREW API IvCalStore_OnUpdate

SFBvCalStore::UnlockCalendar

Unlock the calendar.

[ public ]
SFCError UnlockCalendar(Void);

Reference

BREW API IvCalStore_UnlockCalendar

SFBvCalStore::UpdateObject

Update a calendar Record in the IvCalStore data store of type specified.

[ public ]
SFCError UpdateObject(
    SFBvCalObjectSmpConstRef calendar   // smart pointer to an object to be updated
);

Reference

BREW API IvCalStore_UpdateObject | SFBvCalObject