Difference between revisions of "CopyResource class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=<nowiki>CopyResource</nowiki> |Description=<nowiki>A way to copy resources</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {...")
 
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
|Name=<nowiki>CopyResource</nowiki>
 
|Name=<nowiki>CopyResource</nowiki>
 
|Description=<nowiki>A way to copy resources</nowiki>
 
|Description=<nowiki>A way to copy resources</nowiki>
−
|Constructors=
+
|InheritsFrom=object|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
−
{{CGscriptParameters_Template|Type=number|Name=<nowiki>sourceResourceId</nowiki>|Description=<nowiki>Resource Id of the source</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>destParentResourceId</nowiki>|Description=<nowiki>Resource Id of the parent to copy to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>destName</nowiki>|Description=<nowiki>New resource name</nowiki>}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>sourceResourceId</nowiki>|Description=<nowiki>Resource Id of the source</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>destResourceId</nowiki>|Description=<nowiki>Resource Id of the resource to copy to</nowiki>}}
 +
|Description=<nowiki>Setup the copy of child resources. Finalize copy by calling CopySourceXXX</nowiki>}}
 +
{{CGscriptConstructors_Template|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>sourceResourceId</nowiki>|Description=<nowiki>Resource Id of the source</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>destParentResourceId</nowiki>|Description=<nowiki>Resource Id of the parent to copy to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>destName</nowiki>|Description=<nowiki>New resource name</nowiki>}}
 
|Description=<nowiki>Setup the copy. Finalize copy by calling CopyXXX</nowiki>}}
 
|Description=<nowiki>Setup the copy. Finalize copy by calling CopyXXX</nowiki>}}
 
|Methods=
 
|Methods=
Line 14: Line 17:
 
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyUsers</nowiki>|Description=<nowiki>Copy the users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyRules</nowiki>|Description=<nowiki>Copy the group builder rules</nowiki>}}
 
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyUsers</nowiki>|Description=<nowiki>Copy the users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyRules</nowiki>|Description=<nowiki>Copy the group builder rules</nowiki>}}
 
|Description=<nowiki>Copy a group</nowiki>}}
 
|Description=<nowiki>Copy a group</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>CopyGroupAccess</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyResourceAccess</nowiki>|Description=<nowiki>Copy access to resources</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyNavigationAccess</nowiki>|Description=<nowiki>Copy access to functionality</nowiki>}}
 +
|Description=<nowiki>Copy resource or navigation access</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>CopyProduct</nowiki>|Description=<nowiki>Copy a product</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>CopyProduct</nowiki>|Description=<nowiki>Copy a product</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>CopyProject</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>CopyProject</nowiki>|Parameters=
Line 43: Line 49:
 
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyNavigationAccess</nowiki>|Description=<nowiki>Copy navigation access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyResourceAccess</nowiki>|Description=<nowiki>Copy resource access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyMembership</nowiki>|Description=<nowiki>Copy group memberships</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyUserPrefs</nowiki>|Description=<nowiki>Copy user prefs</nowiki>}}
 
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyNavigationAccess</nowiki>|Description=<nowiki>Copy navigation access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyResourceAccess</nowiki>|Description=<nowiki>Copy resource access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyMembership</nowiki>|Description=<nowiki>Copy group memberships</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>copyUserPrefs</nowiki>|Description=<nowiki>Copy user prefs</nowiki>}}
 
|Description=<nowiki>Copy a User</nowiki>}}
 
|Description=<nowiki>Copy a User</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ResourceIdOfCopy</nowiki>|HasGetter=1|Description=<nowiki>Get the resource id of the copy after copying</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceIdOfCopy</nowiki>|HasGetter=1|Description=<nowiki>Get the resource id of the copy after copying</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
 +
 +
=== Examples ===
 +
 +
<source lang="javascript">
 +
 +
number group_rid_from=6793;
 +
number group_rid_to=7080;
 +
CopyResource a=new CopyResource(6793,7080);
 +
a.CopyGroupAccess(true,true);
 +
 +
</source>

Latest revision as of 08:42, 2 July 2020

CopyResource



A way to copy resources

Parent class

Inherits from object

Constructors

  • (int sourceResourceId "Resource Id of the source", int destResourceId "Resource Id of the resource to copy to") - Setup the copy of child resources. Finalize copy by calling CopySourceXXX
  • (int sourceResourceId "Resource Id of the source", int destParentResourceId "Resource Id of the parent to copy to", string destName "New resource name") - Setup the copy. Finalize copy by calling CopyXXX

Methods

  • Empty CopyBill() - Copy a Bill
  • Empty CopyDiagram(bool copyLayout "Make a copy of the layout") - Copy a diagram
  • Empty CopyGroup(bool copyUsers "Copy the users", bool copyRules "Copy the group builder rules") - Copy a group
  • Empty CopyGroupAccess(bool copyResourceAccess "Copy access to resources", bool copyNavigationAccess "Copy access to functionality") - Copy resource or navigation access
  • Empty CopyProduct() - Copy a product
  • Empty CopyProject(string projectCode "New project code, may be empty ", string clientref "New clientref") - Copy a project
  • Empty CopyQuestionnaire(bool copyQuotas "Copy quotas", bool copyStratifications "Copy stratifications", bool copySamplerules "Copy samplerules", bool sampleRuleCopyRebuild "Rebuild copied sample rules", bool sampleRuleCopyExcludeSource "Add a sample rule that the users should not have participated in the original questionnaire") - Copy a Questionnaire. Always copies template
  • Empty CopyQuestionnaireLayout() - Copy a QuestionnaireLayout
  • Empty CopyQuestionnaireLayoutTemplate() - Copy a QuestionnaireLayoutTemplate
  • Empty CopyQuestionnaireTemplate() - Copy a QuestionnaireTemplate
  • Empty CopyReportStyleSheet() - Copy a ReportStyleSheet
  • Empty CopyReportTemplate() - Copy a ReportTemplate
  • Empty CopySourceAttachments() - Copy the source's Attachments
  • Empty CopySourceConstantOption() - Copy the source's ConstantOption
  • Empty CopySourceData(bool copyNonSample "Copy non-sample data") - Copy the source's Data
  • Empty CopySourceImages() - Copy the source's Images
  • Empty CopySourceJournal() - Copy the source's Journal entries
  • Empty CopySourceParameters() - Copy the source's Parameters
  • Empty CopySourceProductCategories() - Copy the source's ProductCategories
  • Empty CopySourceProductOptions() - Copy the source's ProductOptions
  • Empty CopySourceProperties() - Copy the source's Properties
  • Empty CopyTask(bool copySettings "Copy settings") - Copy a Task
  • Empty CopyUser(bool copyNavigationAccess "Copy navigation access", bool copyResourceAccess "Copy resource access", bool copyMembership "Copy group memberships", bool copyUserPrefs "Copy user prefs") - Copy a User
  • (From object) string ToString() - The string representation of the object.

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • int ResourceIdOfCopy { get; } - Get the resource id of the copy after copying
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

number group_rid_from=6793;
number group_rid_to=7080;
CopyResource a=new CopyResource(6793,7080);
a.CopyGroupAccess(true,true);
Retrieved from "http://wiki.catglobe.com/index.php?title=CopyResource_class&oldid=239664"