Bookshelf v7.5: CSSBCActivity Methods

This section describes the methods that are implemented in the CSSBCActivity Class.

BuildActivityArray

The BuildActivityArray method adds the appointments record from the SQL object, and generates a list of repeating appointment instances that have been overridden.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke BuildActivityArray from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

CalendarNewMode

The CalendarNewMode method specifies whether or not the business component is in Calendar New mode.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke CalendarNewMode from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

CleanEmployeeOnNewRecord

The CleanEmployeeOnNewRecord method triggers the business component to clear the logged-in User Id from the Owner MVG if the logged-in user is different from employee set on the current business component.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke CleanEmployeeOnNewRecord from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

ClearAllowOverrides

The ClearAllowOverrides method turns off the ability for the user to override the search specification on the Activity List view.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke ClearAllowOverrides from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

ClearGridBeginEndDate

The ClearGridBeginEndDate method turns off the instantiated flag and clears the sort specification for the business component.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke ClearGridBeginEndDate from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

ClearModifyFlag

The ClearModifyFlag method turns off the repeating activity modification flag, which indicates that this is a nonrepeating activity.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke ClearModifyFlag from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

CompleteActivity

The CompleteActivity method commits the current record, and passes the current Activity Id to the Complete Activity business service to complete current activity. Once complete, the business component updates the following business components:


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke CompleteActivity from applets, business components, and business services. You can also invoke this method through custom buttons and commands.

CreateCommActivity

The CreateCommActivity method triggers the business component to create a new activity record with the values specified in the arguments. The user will get an error report if one or more fields cannot be set, unless other errors are returned.


Argument	Description
create_attachment	Indicates whether or not to create attachments for Description and Comment if they are too long.
arg2, ..., argX	Named field values in the form "name=value" that are set into the new Activity record.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke CreateCommActivity from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

CreateExceptionRecord

The CreateExceptionRecord method creates a new record as an exception of a repeating appointment.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke CreateExceptionRecord from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

CreateOverrideRecord

The CreateOverrideRecord method creates a new ghost record that overrides an instance of a repeating appointment.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke CreateOverrideRecord from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

DeleteAll

The DeleteAll method deletes the appointment if the user is the primary owner, or dissociates the user from the appointment if the user is not the primary owner.

For repeating and nonrepeating appointments, the DeleteAll method acts on the record.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke DeleteAll from applets, business components, and business services. You can also invoke this method through custom buttons and commands.

DeleteInstance

The DeleteInstance method calls the DeleteThisOne method to delete an instance of the appointment if the user is the primary owner, or dissociates the user from an instance of the appointment if the user is not the primary owner.

For a repeating appointment, the DeleteInstance method acts on a single instance. For a nonrepeating appointment, the DeleteInstance method acts on the record.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke DeleteInstance from applets, business components, and business services. You can also invoke this method through custom buttons and commands.

DeleteThisOne

The DeleteThisOne method deletes an instance of the appointment if the user is the primary owner, or dissociates the user from an instance of the appointment if the user is not the primary owner. This method is called by DeleteInstance.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke DeleteThisOne from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

EmptyActivityArray


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke EmptyActivityArray from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

GetLogin

The GetLogin method returns a string that consists of the logged-in user's name and ID. You can use string-to-array conversion to reference the values separately.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke GetLogin from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

GetPrimaryPositionId

The GetPrimaryPositionId method returns a string that consists of the primary position id of the logged in user, and Y/N system preference value of Auto Calendar Manager Access for this position.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke GetPrimaryPositionId from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

GetSqlExecutedFlag

The GetSqlExecutedFlag method returns a string value of TRUE/FALSE that indicates whether or not Execute will be skipped for this business component.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke GetSqlExecutedFlag from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

InitCalendar


Argument	Description
view_date	View Date for the calendar.
begine_date	Begin Date for the calendar.
end_date	End Date for the calendar.
begin_time	Begin Time for the calendar.
end_time	End Time for the calendar.
grid	(Y/N) Indicates whether or not to include a grid layout.
type	Calendar Type (DAY, WEEK, MONTH).


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke InitCalendar from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsCalendarMode

The IsCalendarMode method returns a Y/N value to indicate whether or not the application is in Calendar Mode. This method is used for wireless applications only.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsCalendarMode from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsInited

The IsInited method verifies whether or not the calendar is initialized. If initialized, this method returns a string value that consists of following values in sequence:


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsInited from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsInitedLocale

The IsInitedLocale method behaves the same as the IsInited method. However, all values are returned as formatted string values according to current locale.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsInitedLocale from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsOnlyLoginUser

The IsOnlyLoginUser method returns a Y/N value to indicate whether or not the logged-in user is the only owner in the Owned By MVG business component, and that there are no records in Contact MVG.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsOnlyLoginUser from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsOriginalRepActivityId

The IsOriginalRepActivityId method returns a Y/N value to indicate whether or not the specified Activity Id is the original repeating Activity Id. If the specified Activity is the original repeating Activity Id, the IsOriginalRepActivityId method returns Y; otherwise it returns N.

Argument	Description
activityId	The Activity Id to check.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsOriginalRepActivityId from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsParticipantsChanged

The IsParticipantsChanged method returns a Y/N value to indicate whether or not new records have been added to either the Owned By MVG or the Contact MVG.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsParticipantsChanged from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsPrimaryInMVG

The IsPrimaryInMVG method returns a Y/N value to indicate whether or not the current employee ID is the primary in the MVG of the specified Field Name.

Argument	Description
fieldname	The name of the field to check.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsPrimaryInMVG from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsRecordRepActivity

The IsRecordRepActivity method returns a Y/N value to indicate whether or not the current activity record is a repeating activity.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsRecordRepActivity from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

IsRepActivityId

The IsRepActivityId method returns a string value of the Repeating Id of a specified Activity Id, and a Y/N value indicating whether or not the specified Activity Id is a repeating activity. You can use string-to-array conversion to reference the returned values separately.

Argument	Description
activityId	The Activity Id to check.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke IsRepActivityId from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

PositionToNewRecFromAux

The PositionToNewRecFromAux method moves the position to the repeat activity record that was created using the SqlWriteRecord method. This method is used for wireless applications only.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke PositionToNewRecFromAux from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

RefreshFields

The RefreshFields method calls the notifynewdata method for each field name specified.


Argument	Description
arg1, ..., argX	Each argument for RefreshFields is a field name.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke RefreshFields from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

RemLoginOnNewRecord

The RemLoginOnNewRecord method removes the logged-in user's ID from the Owned By MVG.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke RemLoginOnNewRecord from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

RemoveFromAuxTeam

The RemoveFromAuxTeam method removes the employees listed in the arguments from Action Employee, where the employee's Activity Id matches the current Activity Id.


Argument	Description
arg1, ..., argX	Each argument for RemoveFromAuxTeam is an Employee Id.

If no Employee Id is specified, this method uses the employee that has been set on the current business component.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke RemoveFromAuxTeam from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

RemoveFromTeam

The RemoveFromTeam method removes the employees listed in the arguments from Action Employee, where the employee's Activity Id matches the current Activity Id.


Argument	Description
arg1, ..., argX	Each argument for RemoveFromTeam is an Employee Id.

If no Employee Id is specified, this method uses the employee that has been set on the current business component.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke RemoveFromTeam from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

ResetInited


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke ResetInited from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SaveThisOne

The SaveThisOne method creates an exception record and an override record for a repeating appointment.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SaveThisOne from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SaveWebCollabData

The SaveWebCollabData method saves Web collaboration chat script and other data.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SaveWebCollabData from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

The arguments for SaveWebCollabData comprise a list of chat script and other data.

SetActivityContact

The SetActivityContact method adds a Contact record for CSSBCBase. It can be either a multivalue field (MVF) on an intersection table plus a single-value field (SVF) on the action Primary Contact Id, or just a SVF on the Action business component.


Argument	Description
contactId	The Contact Id to use for the new Contact record.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetActivityContact from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetAlarmFilter


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetAlarmFilter from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetAllowOverrides

The SetAllowOverrides method allows the ability for the user to override the search specification on the Activity List view.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetAllowOverrides from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetAvailCalUpdateIds

The SetAvailCalUpdateIds method saves the User Id of each user whose calendar the current user can update.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetAvailCalUpdateIds from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetCommTypes


Argument	Description
communicationType	The type of communication to set.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetCommTypes from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetCurrentViewDate


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetCurrentViewDate from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetEmployeeId

The SetEmployeeId method sets the Employee Login Id and Employee Login Name for the current Activity business component.


Argument	Description
emp_login_id	The Employee Login Id to set.
emp_login_name	The Employee Login Name to set.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetEmployeeId from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetEmployeeList

The SetEmployeeList method sets Employee Ids for the current business component to support multiple employees. The arguments for SetEmployeeList consist of Employee Ids for each employee to put in the list.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetEmployeeList from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetGridBeginEndDate


Argument	Description
beginDate	The Begin Date for the grid.
endDate	The End Date for the grid.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetGridBeginEndDate from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetModifyFlag


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetModifyFlag from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.

SetSkipSqlExecuteFlag

The SetSkipSqlExecuteFlag method sets a flag to prevent execution of the business component.


Origin	Implemented in CSSBCActivity.
Invocable	You can invoke SetSkipSqlExecuteFlag from applets, business components, and business services. However, you cannot invoke this method through custom buttons and commands.