C# Class Omb.Domain.DKCoinMgr

Inheritance: Omb.ObjectMgr

Exibir arquivo Open project: dkcoin/dkCOIN-1.2

Public Properties

Property	Type	Description
webservice	dkCOIN.dkcoin

Private Properties

Property	Type	Description

Public Methods

Method	Description
DeleteResource ( string internal_id, string collection_name ) : void	Deletes a Resources
DeleteResource ( string source_id, string internal_id, string collection_name ) : void	Deletes a Resources
EmailErrorNotification ( string msg, string info ) : void	Quietly sends an email error report to [email protected] with additional information
EndSession ( ) : string	Ends Current Session
GetAcronym ( ) : string	Gets the Consortium's Acronym
GetDKResourceTypes ( ) : DKCoinResourceTypeList	Get ResourceTypes to be displayed
GetDomain ( ) : string	Get's the URL
GetEntities ( string keywords ) : DKCoinResourceList
GetGeneIDsFromStrain ( ID StrainID ) : string[]	returns a string array of gene_ids associated with a strain (transgenes, gene genotypes, genomic segments)
GetResourceTypes ( ) : DKCoinResourceTypeList	Get ResourceTypes
GetResourceTypesAsStringList ( ) : StringList	Get ResourceTypes
GetResources ( DKCoinSearch Search ) : DKCoinResourceList	Gets dkCOIN resources
GetResources ( dkCOIN parameters ) : DKCoinResourceList	Gets dkCOIN resources
GetResources ( string gene_ids ) : DKCoinResourceList	Gets dkCOIN resources
GetResources ( string resourceType, string resourceName, bool ignoreResourceType ) : DKCoinResourceList	Gets dkCOIN resources
GetSourceID ( ) : string	Returns the Source ID associated with the current consortium
GetSources ( ) : DKCoinSourceList	Gets dkCOIN Sources
GetSources ( bool ExcludeConsortium ) : DKCoinSourceList	Get Sources
GetUrl ( string ResourceType ) : string	Returned formatted Url for Specified Resource Type
ReadEntities ( dkCOIN entities ) : DKCoinResourceList	Reads dkCOIN resources into a DKCoinResourceList object
ReadResources ( dkCOIN resources ) : DKCoinResourceList	Reads dk COIN resources into a DKCoinResourceList object
ReadSources ( dkCOIN sources ) : DKCoinSourceList	Reads dk COIN sources into a DKCoinSourceList object
ResourceExists ( string resource_name ) : bool	Check if the resource is in the dkCOIN database
StartSession ( ) : string	Creates new Session for webservices
UpdateAll ( ) : void	Updates All Consortial Protocols, Strains and Histology Images
UpdateCollection ( string source_id, string name, string displayname, string urltemplate ) : string	Updates a Collection
UpdateDKCoinResourceType ( ID dkResourceTypeID, bool DisplayResource, SecurityContext sc ) : void	Updates dk COIN Resource Type displayed by default (Admins only)
UpdateHistology ( ) : void	Updates All Histology Images
UpdateHistology ( HistologyImage image ) : void	Update Single Histology Image
UpdateHistology ( HistologyImageList images ) : void	Updates Histology Images
UpdateProtocol ( Protocol protocol ) : void	Updates a single protocol
UpdateProtocols ( ) : void	Updates All Protocols
UpdateProtocols ( ProtocolList protocols ) : void	Updates Protocols
UpdatePublication ( Publication publication ) : void	Updates a single publication
UpdatePublications ( ) : void	Updates All Publications
UpdatePublications ( PublicationList publications ) : void	Updates Publications
UpdateResource ( DKCoinResource resource ) : string	Updates a Resource
UpdateResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created ) : string	Update a Resource
UpdateResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created, string ontologies ) : string	Update a Resource
UpdateResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created, string gene_ids, string ontologies, string pubmedid ) : string	Update a Resource
UpdateStrain ( Strain strain ) : string	Updates a single strain
UpdateStrain ( Strain strain, string pubmedid ) : string	Updates Single Strain with an associated pubmedid
UpdateStrains ( ) : StringList	Updates All Strains
UpdateStrains ( StrainList strains ) : StringList	Updates Strains

Protected Methods

Method	Description
DKCoinMgr ( ) : System.Text.RegularExpressions	forces use of object factory
GetDatabase ( ) : Database	Returns the enum for Admin Database
ObjectToResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created, string gene_ids, string ontologies, string pubmedid ) : DKCoinResource	Creates a DKCoinResource Object from supplied parameters

Method Details

DKCoinMgr() protected method

forces use of object factory

protected DKCoinMgr ( ) : System.Text.RegularExpressions
return	System.Text.RegularExpressions

DeleteResource() public method

Deletes a Resources

public DeleteResource ( string internal_id, string collection_name ) : void
internal_id	string	string object (Internal Resource ID)
collection_name	string	string object (Collection Name)
return	void

DeleteResource() public method

Deletes a Resources

public DeleteResource ( string source_id, string internal_id, string collection_name ) : void
source_id	string	string object (Source ID)
internal_id	string	string object (Internal Resource ID)
collection_name	string	string object (Collection Name)
return	void

EmailErrorNotification() public method

Quietly sends an email error report to [email protected] with additional information

public EmailErrorNotification ( string msg, string info ) : void
msg	string
info	string
return	void

EndSession() public method

Ends Current Session

public EndSession ( ) : string
return	string

GetAcronym() public method

Gets the Consortium's Acronym

public GetAcronym ( ) : string
return	string

GetDKResourceTypes() public method

Get ResourceTypes to be displayed

public GetDKResourceTypes ( ) : DKCoinResourceTypeList
return	DKCoinResourceTypeList

GetDatabase() protected method

Returns the enum for Admin Database

protected GetDatabase ( ) : Database
return	Database

GetDomain() public method

Get's the URL

public GetDomain ( ) : string
return	string

GetEntities() public method

public GetEntities ( string keywords ) : DKCoinResourceList
keywords	string
return	DKCoinResourceList

GetGeneIDsFromStrain() public method

returns a string array of gene_ids associated with a strain (transgenes, gene genotypes, genomic segments)

public GetGeneIDsFromStrain ( ID StrainID ) : string[]
StrainID	ID	ID Object
return	string[]

GetResourceTypes() public method

Get ResourceTypes

public GetResourceTypes ( ) : DKCoinResourceTypeList
return	DKCoinResourceTypeList

GetResourceTypesAsStringList() public method

Get ResourceTypes

public GetResourceTypesAsStringList ( ) : StringList
return	StringList

GetResources() public method

Gets dkCOIN resources

public GetResources ( DKCoinSearch Search ) : DKCoinResourceList
Search	DKCoinSearch	DKCoinSearch Object
return	DKCoinResourceList

GetResources() public method

Gets dkCOIN resources

public GetResources ( dkCOIN parameters ) : DKCoinResourceList
parameters	dkCOIN	typeSearchParams object
return	DKCoinResourceList

GetResources() public method

Gets dkCOIN resources

public GetResources ( string gene_ids ) : DKCoinResourceList
gene_ids	string	string object
return	DKCoinResourceList

GetResources() public method

Gets dkCOIN resources

public GetResources ( string resourceType, string resourceName, bool ignoreResourceType ) : DKCoinResourceList
resourceType	string	resourceType object
resourceName	string	string object
ignoreResourceType	bool	bool object
return	DKCoinResourceList

GetSourceID() public method

Returns the Source ID associated with the current consortium

public GetSourceID ( ) : string
return	string

GetSources() public method

Gets dkCOIN Sources

public GetSources ( ) : DKCoinSourceList
return	DKCoinSourceList

GetSources() public method

Get Sources

public GetSources ( bool ExcludeConsortium ) : DKCoinSourceList
ExcludeConsortium	bool
return	DKCoinSourceList

GetUrl() public method

Returned formatted Url for Specified Resource Type

public GetUrl ( string ResourceType ) : string
ResourceType	string	string object
return	string

ObjectToResource() protected method

Creates a DKCoinResource Object from supplied parameters

protected ObjectToResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created, string gene_ids, string ontologies, string pubmedid ) : DKCoinResource
source_id	string	string object
name	string	string object
internal_id	string	string object
description	string	string object
internal_url	string	string object
resourceType	string	string object
collection_name	string	string object
date_created	System.DateTime	DateTime object
gene_ids	string	string array
ontologies	string	string array
pubmedid	string	string object
return	DKCoinResource

ReadEntities() public method

Reads dkCOIN resources into a DKCoinResourceList object

public ReadEntities ( dkCOIN entities ) : DKCoinResourceList
entities	dkCOIN	typeSearchResultEntity[] object
return	DKCoinResourceList

ReadResources() public method

Reads dk COIN resources into a DKCoinResourceList object

public ReadResources ( dkCOIN resources ) : DKCoinResourceList
resources	dkCOIN	typeSearchResource[] object
return	DKCoinResourceList

ReadSources() public method

Reads dk COIN sources into a DKCoinSourceList object

public ReadSources ( dkCOIN sources ) : DKCoinSourceList
sources	dkCOIN
return	DKCoinSourceList

ResourceExists() public method

Check if the resource is in the dkCOIN database

public ResourceExists ( string resource_name ) : bool
resource_name	string	string object
return	bool

StartSession() public method

Creates new Session for webservices

public StartSession ( ) : string
return	string

UpdateAll() public method

Updates All Consortial Protocols, Strains and Histology Images

public UpdateAll ( ) : void
return	void

UpdateCollection() public method

Updates a Collection

public UpdateCollection ( string source_id, string name, string displayname, string urltemplate ) : string
source_id	string	string object
name	string	string object
displayname	string	string object
urltemplate	string	string object
return	string

UpdateDKCoinResourceType() public method

Updates dk COIN Resource Type displayed by default (Admins only)

public UpdateDKCoinResourceType ( ID dkResourceTypeID, bool DisplayResource, SecurityContext sc ) : void
dkResourceTypeID	ID	ID object
DisplayResource	bool	bool object
sc	SecurityContext	Security Context object
return	void

UpdateHistology() public method

Updates All Histology Images

public UpdateHistology ( ) : void
return	void

UpdateHistology() public method

Update Single Histology Image

public UpdateHistology ( HistologyImage image ) : void
image	HistologyImage	HistologyImage Object
return	void

UpdateHistology() public method

Updates Histology Images

public UpdateHistology ( HistologyImageList images ) : void
images	HistologyImageList	HistologyImageList object
return	void

UpdateProtocol() public method

Updates a single protocol

public UpdateProtocol ( Protocol protocol ) : void
protocol	Protocol	Protocol Object
return	void

UpdateProtocols() public method

Updates All Protocols

public UpdateProtocols ( ) : void
return	void

UpdateProtocols() public method

Updates Protocols

public UpdateProtocols ( ProtocolList protocols ) : void
protocols	ProtocolList	ProtocolList object
return	void

UpdatePublication() public method

Updates a single publication

public UpdatePublication ( Publication publication ) : void
publication	Publication	Publication Object
return	void

UpdatePublications() public method

Updates All Publications

public UpdatePublications ( ) : void
return	void

UpdatePublications() public method

Updates Publications

public UpdatePublications ( PublicationList publications ) : void
publications	PublicationList	PublicationList object
return	void

UpdateResource() public method

Updates a Resource

public UpdateResource ( DKCoinResource resource ) : string
resource	DKCoinResource	DKCoinResource Object
return	string

UpdateResource() public method

Update a Resource

public UpdateResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created ) : string
source_id	string	string object
name	string	string object
internal_id	string	string object
description	string	string object
internal_url	string	string object
resourceType	string	resourceType object
collection_name	string	string object
date_created	System.DateTime	DateTime object
return	string

UpdateResource() public method

Update a Resource

public UpdateResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created, string ontologies ) : string
source_id	string	string object
name	string	string object
internal_id	string	string object
description	string	string object
internal_url	string	string object
resourceType	string	resourceType object
collection_name	string	string object
date_created	System.DateTime	DateTime object
ontologies	string	string array
return	string

UpdateResource() public method

Update a Resource

public UpdateResource ( string source_id, string name, string internal_id, string description, string internal_url, string resourceType, string collection_name, System.DateTime date_created, string gene_ids, string ontologies, string pubmedid ) : string
source_id	string	string object
name	string
internal_id	string	string object
description	string	string object
internal_url	string	string object
resourceType	string	resourceType object
collection_name	string	string object
date_created	System.DateTime	DateTime object
gene_ids	string	string[] object
ontologies	string	string[] object
pubmedid	string	string object
return	string

UpdateStrain() public method

Updates a single strain

public UpdateStrain ( Strain strain ) : string
strain	Strain
return	string

UpdateStrain() public method

Updates Single Strain with an associated pubmedid

public UpdateStrain ( Strain strain, string pubmedid ) : string
strain	Strain
pubmedid	string
return	string

UpdateStrains() public method

Updates All Strains

public UpdateStrains ( ) : StringList
return	StringList

UpdateStrains() public method

Updates Strains

public UpdateStrains ( StrainList strains ) : StringList
strains	StrainList	StrainList Object
return	StringList

Property Details

webservice public_oe property

dkCOIN web service

public dkCOIN.dkcoin webservice
return	dkCOIN.dkcoin