Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

WorkContext
[System Administration]

Functions


Function Documentation

SA_API int SA_ask_current_location_code ( char **  locCodePref  ) 

return the Current LocationCode for the session.

Parameters:
locCodePref  (OF)

SA_API int SA_ask_current_organization ( tag_t organizationTag  ) 

return the Current Organization for the session.

Parameters:
organizationTag  (O)

SA_API int SA_ask_current_project ( tag_t project  ) 

return the Current Project for the session.

Parameters:
project  (O)

SA_API int SA_ask_current_user_context ( tag_t user_context  ) 

Retrieves the current User Context of the session. Returns ITK_ok, always

Parameters:
user_context  (O) The session current User Context

SA_API int SA_ask_current_work_context ( tag_t workcontext  ) 

return the Current Work Context for the session.

Parameters:
workcontext  (O)

SA_API int SA_ask_user_work_contexts ( tag_t  user,
int *  n_workcontexts,
tag_t **  workcontexts 
)

return the work contexts associated with the user's workflow tasks (Tasks to Perform) or their targets .

Parameters:
user  (I)
n_workcontexts  (O)
workcontexts  (OF) n_workcontexts

SA_API int SA_assign_work_context ( tag_t  workcontext,
tag_t  target 
)

Assign the given workcontext to the given target.

Parameters:
workcontext  (I)
target  (I)

SA_API int SA_create_work_context ( const char *  name,
const char *  desc,
tag_t  group,
tag_t  role,
tag_t  user,
tag_t  project,
logical  allowSubgroups,
logical  settingModifiable,
tag_t newWorkContext 
)

Create a new work context with the given name, desc, group, role, user, project.

Parameters:
name  (I)
desc  (I)
group  (I)
role  (I)
user  (I)
project  (I)
allowSubgroups  (I)
settingModifiable  (I)
newWorkContext  (O)

SA_API int SA_remove_work_context ( tag_t  workcontext,
tag_t  target 
)

remove the given workcontext from the given target.

Parameters:
workcontext  (I)
target  (I)

SA_API int SA_set_current_location_code ( char *  locCodePref  ) 

set the Current LocationCode for the session

Parameters:
locCodePref  (I)

SA_API int SA_set_current_organization ( tag_t  organizationTag  ) 

set the given organization/group as Current Organization for the session.

Parameters:
organizationTag  (I)

SA_API int SA_set_current_project ( tag_t  project  ) 

set the given project as Current Project for the session.

Parameters:
project  (I)

SA_API int SA_set_current_work_context ( tag_t  workcontext  ) 

set the given workcontext as Current Work Context for the session.

Parameters:
workcontext  (I)