Bookshelf v7.7: CSSBCActivity Methods

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

ClearGridBeginEndDate

The ClearGridBeginEndDate method returns the business component to regular mode after it has been set to calendar mode with the SetGridBeginEndDate method.


Origin	Implemented in CSSBCActivity.
Invocable	This method can be invoked through InvokeMethod only.


Can be invoked by:
Server Script	Browser Script	Custom Button	Command	External Interfaces	Comment
Yes	Yes	No	No	No	You can invoke this method from applets, business components, or business services.

CompleteActivity

The CompleteActivity method commits the activity record and calculates the costs associated with an activity. It then updates the parts, time, and expense records of the activity with the costs of each item based on the price list, rate list, and cost list.

In the preconfigured application, the CompleteActivity method is invoked by the Complete Activity business service. The Complete Activity business service is called when an activity record is saved.

This method is typically used with the Action business component, but may be used with other business components in the CSSBCActivity class.


Origin	Implemented in CSSBCActivity.
Invocable	This method can be invoked through InvokeMethod only.


Can be invoked by:
Server Script	Browser Script	Custom Button	Command	External Interfaces	Comment
Yes	Yes	Yes	Yes	No	You can invoke this method from applets, business components, and business services.

IsPrimaryInMVG

The IsPrimaryInMVG method returns Y or N to indicate whether the logged-in user is the primary in the multi-value group of a specified field.

This method can be used to determine whether the logged-in user is allowed to perform operations that are limited to the primary in the multi-value group. For example, only the primary may be allowed to change the primary.


Argument	Type	Description
fieldname	string	The name of the field to check.


Origin	Implemented in CSSBCActivity.
Invocable	This method can be invoked through InvokeMethod only.


Can be invoked by:
Server Script	Browser Script	Custom Button	Command	External Interfaces	Comment
Yes	Yes	No	No	No	You can invoke this method from applets, business components, or business services.

SetEmployeeId

The SetEmployeeId method sets the criteria of the next SQL query on the current activity business component to the row Id and login provided as input arguments, to enable visibility of that employee's calendar records.


Argument	Type	Description
emp_login_id	string	The row Id of the employee whose calendar records are returned.
emp_login_name	string	The Login of the employee whose calendar records are returned.


Origin	Implemented in CSSBCActivity.
Invocable	This method can be invoked through InvokeMethod only.


Can be invoked by:
Server Script	Browser Script	Custom Button	Command	External Interfaces	Comment
Yes	Yes	No	No	No	You can invoke this method from applets, business components, and business services.

SetGridBeginEndDate

The SetGridBeginEndDate method sets the business component to Calendar mode and sets the beginning and ending dates for the grid.

This method is required in script that manipulates the business component in Calendar mode, such as manipulating the instances of a recurring activity.

CAUTION: To avoid performance impact, set the date interval so that a large number of records, for example more than 1000, are not returned. Typically, the interval should be set as a month or a week. In the preconfigured application, this method is typically invoked with intervals of a calendar month or a calendar week.

The business component is returned from Calendar mode to its regular mode by the ClearGridBeginEndDate method.


Argument	Type	Description
beginDate	string	The beginning date for the grid in the object manager's time zone in the form mm/dd/yyyy. The beginning time for this date is interpreted as midnight at the beginning of the day.
endDate	string	The ending date for the grid, also in mm/dd/yyyy form. The ending time for this date is interpreted as midnight at the end of the day.


Origin	Implemented in CSSBCActivity.
Invocable	This method can be invoked through InvokeMethod only.


Can be invoked by:
Server Script	Browser Script	Custom Button	Command	External Interfaces	Comment
Yes	Yes	No	No	No	You can invoke this method from applets, business components, or business services.