autodocs_module_admin_ui

Module admin_ui Owner: sam@smoke Work package: WPx.y Description: this is a Web-based administrative user interface for an instance of the OpenShare system

Method call: database.create_person() Implemented in: database Called by: admin_ui Description: creates a new person in database Parameters: Name: p Type: person Description: a specific human being

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_person() Implemented in: database Called by: admin_ui Description: gets a specific person from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: p Type: person Description: a specific human being

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_person() Implemented in: database Called by: admin_ui Description: updates a specific person in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	p
Type:	person
Description:	a specific human being

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_person() Implemented in: database Called by: admin_ui Description: deletes a specific person from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_people() Implemented in: database Called by: admin_ui Description: lists all people in the database Parameters: None Returns: Name: p Type: A list of people Description: a specific human being

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_organization() Implemented in: database Called by: admin_ui Description: creates a new organization in database Parameters: Name: o Type: organization Description: a collection of human beings and/or other organizations

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_organization() Implemented in: database Called by: admin_ui Description: gets a specific organization from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: o Type: organization Description: a collection of human beings and/or other organizations

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_organization() Implemented in: database Called by: admin_ui Description: updates a specific organization in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	o
Type:	organization
Description:	a collection of human beings and/or other organizations

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_organization() Implemented in: database Called by: admin_ui Description: deletes a specific organization from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_organizations() Implemented in: database Called by: admin_ui Description: list all organizations in database Parameters: None Returns: Name: o Type: A list of organizations Description: a collection of human beings and/or other organizations

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_resource() Implemented in: database Called by: admin_ui Description: creates a new resource in database Parameters: Name: r Type: resource Description: any non-human resource

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_resource() Implemented in: database Called by: admin_ui Description: gets a specific resource from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: r Type: resource Description: any non-human resource

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_resource() Implemented in: database Called by: admin_ui Description: updates a specific resource in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	r
Type:	resource
Description:	any non-human resource

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_resource() Implemented in: database Called by: admin_ui Description: deletes a specific resource from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_resources() Implemented in: database Called by: admin_ui Description: lists all resources in the database Parameters: None Returns: Name: r Type: A list of resources Description: any non-human resource

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_workflow_template() Implemented in: database Called by: admin_ui Description: creates a new workflow template in database Parameters: Name: w Type: workflow_template Description: human-designed work process

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_template() Implemented in: database Called by: admin_ui Description: gets a specific workflow template from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_template Description: human-designed work process

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_template() Implemented in: database Called by: admin_ui Description: updates a specific workflow template in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_template
Description:	human-designed work process

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_template() Implemented in: database Called by: admin_ui Description: deletes a specific workflow template in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_templates() Implemented in: database Called by: admin_ui Description: lists all workflow templates in database Parameters: None Returns: Name: w Type: A list of workflow_templates Description: human-designed work process

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_workflow_definition() Implemented in: database Called by: admin_ui Description: creates a new workflow definition in database Parameters: Name: w Type: workflow_definition Description: filled in template, instances are stamped out from this

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_definition() Implemented in: database Called by: admin_ui Description: gets a specific workflow definition from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_definition Description: filled in template, instances are stamped out from this

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_definition() Implemented in: database Called by: admin_ui Description: updates a specific workflow definition in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_definition
Description:	filled in template, instances are stamped out from this

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_definition() Implemented in: database Called by: admin_ui Description: deletes a specific workflow definition in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_definitions() Implemented in: database Called by: admin_ui Description: lists all workflow definitions in database Parameters: None Returns: Name: w Type: A list of workflow_definitions Description: filled in template, instances are stamped out from this

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_workflow_node() Implemented in: database Called by: admin_ui Description: creates a workflow node in database Parameters: Name: w Type: workflow_node Description: a node in a workflow diagram

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_node() Implemented in: database Called by: admin_ui Description: gets a specific workflow node from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_node Description: a node in a workflow diagram

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_node() Implemented in: database Called by: admin_ui Description: updates a specific workflow node in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_node
Description:	a node in a workflow diagram

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_node() Implemented in: database Called by: admin_ui Description: deletes a workflow node from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_nodes() Implemented in: database Called by: admin_ui Description: lists all workflow nodes in database Parameters: None Returns: Name: w Type: A list of workflow_nodes Description: a node in a workflow diagram

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_workflow_instance() Implemented in: database Called by: admin_ui Description: creates a workflow instance in database Parameters: Name: w Type: workflow_instance Description: a controller process, a bit like a make

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_instance() Implemented in: database Called by: admin_ui Description: gets a specific workflow instance from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_instance Description: a controller process, a bit like a make

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_instance() Implemented in: database Called by: admin_ui Description: updates a specific workflow instance in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_instance
Description:	a controller process, a bit like a make

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_instance() Implemented in: database Called by: admin_ui Description: deletes a specific workflow instance in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_instances() Implemented in: database Called by: admin_ui Description: lits all workflow instances in database Parameters: None Returns: Name: w Type: A list of workflow_instances Description: a controller process, a bit like a make

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_fact_entry() Implemented in: database Called by: admin_ui Description: create a new fact entry in database Parameters: Name: f Type: fact_entry Description: a fact as stored in the database, eg. 'available_VMs = 4'

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_fact_entry() Implemented in: database Called by: admin_ui Description: get a specific fact entry from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: f Type: fact_entry Description: a fact as stored in the database, eg. 'available_VMs = 4'

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_fact_entry() Implemented in: database Called by: admin_ui Description: update a specific fact entry in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	f
Type:	fact_entry
Description:	a fact as stored in the database, eg. 'available_VMs = 4'

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_fact_entry() Implemented in: database Called by: admin_ui Description: delete a specific fact entry from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_fact_entries() Implemented in: database Called by: admin_ui Description: list all fact entries in database Parameters: None Returns: Name: f Type: A list of fact_entries Description: a fact as stored in the database, eg. 'available_VMs = 4'

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_member_of() Implemented in: database Called by: admin_ui Description: create a member-of relationship between two entities Parameters: Name: m Type: member_of Description: relationship of people and organizations to one another

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_member_of() Implemented in: database Called by: admin_ui Description: get a member-of relationship by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: m Type: member_of Description: relationship of people and organizations to one another

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_member_of() Implemented in: database Called by: admin_ui Description: update a member-of relationship by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	m
Type:	member_of
Description:	relationship of people and organizations to one another

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_member_of() Implemented in: database Called by: admin_ui Description: delete a member-of relationship Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_members_of() Implemented in: database Called by: admin_ui Description: list all member-of relationships Parameters: None Returns: Name: m Type: A list of members_of Description: relationship of people and organizations to one another

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_owner_of() Implemented in: database Called by: admin_ui Description: create a new owner-of relationships Parameters: Name: o Type: owner_of Description: relationship of resources to people and organizations

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_owner_of() Implemented in: database Called by: admin_ui Description: get a owner-of relationship by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: o Type: owner_of Description: relationship of resources to people and organizations

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_owner_of() Implemented in: database Called by: admin_ui Description: update an owner-of relationship by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	o
Type:	owner_of
Description:	relationship of resources to people and organizations

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_owner_of() Implemented in: database Called by: admin_ui Description: delete an owner-of relationship Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_owners_of() Implemented in: database Called by: admin_ui Description: list all owner-of relationships Parameters: None Returns: Name: o Type: A list of owners_of Description: relationship of resources to people and organizations

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_access_rule() Implemented in: database Called by: admin_ui Description: creates an access rule in database Parameters: Name: a Type: access_rule Description: a logical rule restricting access to resources

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_access_rule() Implemented in: database Called by: admin_ui Description: gets a specific access rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: a Type: access_rule Description: a logical rule restricting access to resources

Responsible parties: jazz@imperial, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_access_rule() Implemented in: database Called by: admin_ui Description: updates a specific access rule in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	a
Type:	access_rule
Description:	a logical rule restricting access to resources

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_access_rule() Implemented in: database Called by: admin_ui Description: deletes a specific access rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_access_rules() Implemented in: database Called by: admin_ui Description: lists all access rules in database Parameters: None Returns: Name: a Type: A list of access_rules Description: a logical rule restricting access to resources

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_performance_datum() Implemented in: database Called by: admin_ui Description: create a new performance datum record Parameters: Name: p Type: performance_datum Description: a measured observation of system performance

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: neil@mediachannel, sam@smoke, tim@mirriad Work packages: WPx.y

Method call: database.get_performance_datum() Implemented in: database Called by: admin_ui Description: get a specific performance datum record by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: p Type: performance_datum Description: a measured observation of system performance

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_performance_datum() Implemented in: database Called by: admin_ui Description: update a specific performance datum record by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	p
Type:	performance_datum
Description:	a measured observation of system performance

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_performance_datum() Implemented in: database Called by: admin_ui Description: delete a specific performance datum record by key Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_performance_data() Implemented in: database Called by: admin_ui Description: get a list of all performance data records Parameters: None Returns: Name: p Type: A list of performance_data Description: a measured observation of system performance

Responsible parties: neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_performance_rule() Implemented in: database Called by: admin_ui Description: creates a performance rule in database Parameters: Name: p Type: performance_rule Description: a logical rule modeling system performance, either specified manually, or learned from recorded data

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke, tim@mirriad Work packages: WPx.y

Method call: database.get_performance_rule() Implemented in: database Called by: admin_ui Description: gets a specific performance rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: p Type: performance_rule Description: a logical rule modeling system performance, either specified manually, or learned from recorded data

Responsible parties: james@mirriad, jazz@imperial, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_performance_rule() Implemented in: database Called by: admin_ui Description: updates a specific performance rule in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	p
Type:	performance_rule
Description:	a logical rule modeling system performance, either specified manually, or learned from recorded data

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_performance_rule() Implemented in: database Called by: admin_ui Description: deletes a specific performance rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_performance_rules() Implemented in: database Called by: admin_ui Description: lists all performance rules in database Parameters: None Returns: Name: p Type: A list of performance_rules Description: a logical rule modeling system performance, either specified manually, or learned from recorded data

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: message_bus.send_message() Implemented in: message_bus Called by: admin_ui Description: sends a message to the message switch Parameters: Name: m Type: message Description: a non-specific message

Returns: None Responsible parties: james@mirriad, john@ovation, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: message_bus.get_message() Implemented in: message_bus Called by: admin_ui Description: called (possibly implicitly) by other modules to receive a message from the message switch Parameters: None Returns: Name: m Type: message Description: a non-specific message

Responsible parties: james@mirriad, john@ovation, neil@mediachannel, sam@smoke Work packages: WPx.y