==========
[OZ Software]
==========

OZ 소프트웨어 기능을 수행하기 위한  필수 API 를 정의


---------
OZ Software API
---------

FORCS OZ 제품에 대한 연동 기능을 제공한다.




.. _statusType:

status Type
------------


============  ===================
Type          Description             
============  ===================
PROCESSING    	진행 중
SUCCESS    		정상 처리됨
FAIL     		처리 중 문제가 발생함
============  ===================


뷰어 생성
--------------

.. js:function:: M.plugin("ozviewer").create( setting )

	.. versionchanged:: 2.0.0

	
	:param Object setting: 설정 정보
	:param String setting.param: 생성 정보 
	:param Object setting.option: 옵션 정보
	:param Object setting.option.margin: 화면 margin
	:param String setting.option.delimiter: param 의 구분자값 
	:param String setting.option.close: 종료버튼 선언 (Only IOS)
	:param Function setting.callback: 검증 결과  콜백 함수
	
	.. js:function:: callback(status, result)

	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 생성 결과
		
	* param 정보를 기반으로, 화면을 생성함.

	Example:

	    .. code-block:: javascript
	        
	        var params = "connection.openfile=http://oz.sample.com/www/oz/param1.ozd";
	            M.plugin("ozviewer").create({
	               'param': params,
	               callback:function(status, result){
	                   alert(JSON.stringify(result));
	               }
	            });;



	    .. code-block:: javascript
	        
	        var params = "connection.openfile=res://param2.ozd";
	            params += "^" + "comment.all=true";
	            params += "^" + "eform.imagepicker_camera_show_choose_button=true";
	            params += "^" + "eform.inputeventcommand=true";
	            params += "^" + "eform.signpad_type=zoom";
	            params += "^" + "eform.show_prev_next_input=true";
	            params += "^" + "eform.radiobutton_type=dialog";
	            params += "^" + "eform.checkbox_type=dialog_at_prev_next";
	            params += "^" + "viewer.useractioncommand=true";

	        var option = {};
	            option.delimiter = "^";
	            var margin = {};
	            margin.left = 100;
	            margin.top = 100;
	            margin.right = 0;
	            margin.bottom = 0;
	            option.margin = margin;

	        M.plugin("ozviewer").create({
	            'param': params,
	            'option': option,
	            callback:function(status, result){
	                alert(JSON.stringify(result));
	            }
	        });




ReBind  
--------------

.. js:function:: M.plugin('ozviewer').rebind( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param int setting.index: index
	:param String setting.type: type
	:param String setting.param: rebind param 정의
	:param Object setting.option: option 정보
	:param String setting.option.delimiter: delimiter
	:param String setting.option.keep: keep 여부 ("TRUE", "FALSE")
	:param Function setting.callback: rebind 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* index 에 대한 문서를 rebind.


	Example:

	    .. code-block:: javascript
	 
	        var params = "connection.openfile=res://param2.ozd";
	            params += "\n" + "comment.all=true";
	            params += "\n" + "eform.imagepicker_camera_show_choose_button=true";
	            params += "\n" + "eform.inputeventcommand=true";
	            params += "\n" + "eform.signpad_type=zoom";
	            params += "\n" + "eform.show_prev_next_input=true";
	            params += "\n" + "eform.radiobutton_type=dialog";
	            params += "\n" + "eform.checkbox_type=dialog_at_prev_next";
	            params += "\n" + "viewer.useractioncommand=true";

	        M.plugin("ozviewer").rebind({
	           'index': index,
	           'type': type,
	           'param': params,
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });


	    .. code-block:: javascript

	        var params = "connection.openfile=res://param2.ozd";
	            params += "^" + "comment.all=true";
	            params += "^" + "eform.imagepicker_camera_show_choose_button=true";
	            params += "^" + "eform.inputeventcommand=true";
	            params += "^" + "eform.signpad_type=zoom";
	            params += "^" + "eform.show_prev_next_input=true";
	            params += "^" + "eform.radiobutton_type=dialog";
	            params += "^" + "eform.checkbox_type=dialog_at_prev_next";
	            params += "^" + "viewer.useractioncommand=true";

	        var option = {};
	        option.delimiter = "^";
	        option.keep = "TRUE";
	        
	        M.plugin("ozviewer").rebind({
	           'index': index,
	           'type': type,
	           'param': params,
	           'option':option,
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



NewReport  
--------------

.. js:function:: M.plugin('ozviewer').newReport( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.param: report용 param 정보
	:param String setting.delimiter: delimiter
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* report 처리.


	Example:

	    .. code-block:: javascript
	 
	        var params = "connection.openfile=res://param2.ozd";
	            params += "$$" + "comment.all=true";
	            params += "$$" + "eform.imagepicker_camera_show_choose_button=true";
	            params += "$$" + "eform.inputeventcommand=true";
	            params += "$$" + "eform.signpad_type=zoom";
	            params += "$$" + "eform.show_prev_next_input=true";
	            params += "$$" + "eform.radiobutton_type=dialog";
	            params += "$$" + "eform.checkbox_type=dialog_at_prev_next";
	            params += "$$" + "viewer.useractioncommand=true";

	        M.plugin("ozviewer").newReport({
	           'param': params,
	           'delimiter' : "$$",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });




GetInformation  
--------------

.. js:function:: M.plugin('ozviewer').getInfo( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.item: item info 
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* 문서 정보 획득.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").getInfo({
	           'item': "INPUT_JSON",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



Script  
--------------

.. js:function:: M.plugin('ozviewer').script( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.cmd: script command 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* Script 명령어 처리.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").script({
	           'cmd': "command",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



ScriptEx  
--------------

.. js:function:: M.plugin('ozviewer').scriptEx( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.cmd: script command 정보
	:param String setting.param: param 정보
	:param String setting.delimiter: delimiter 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* 확장 Script 명령어 처리.


	Example:

	    .. code-block:: javascript
	 
	        var params = "connection.openfile=res://param2.ozd";
	            params += "$$" + "comment.all=true";
	            params += "$$" + "eform.imagepicker_camera_show_choose_button=true";
	            params += "$$" + "eform.inputeventcommand=true";
	            params += "$$" + "eform.signpad_type=zoom";
	            params += "$$" + "eform.show_prev_next_input=true";
	            params += "$$" + "eform.radiobutton_type=dialog";
	            params += "$$" + "eform.checkbox_type=dialog_at_prev_next";
	            params += "$$" + "viewer.useractioncommand=true";

	        M.plugin("ozviewer").scriptEx({
	           'cmd' : "command",        	
	           'param': params,
	           'delimiter' : "$$",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



setHelpURL  
--------------

.. js:function:: M.plugin('ozviewer').setHelpURL( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.url: help url 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* help url 정보 셋팅.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").scriptEx({
	           'url' : "http://doc.sample.com/help.html",        	
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



GetMemoryStreamByExport  
--------------

.. js:function:: M.plugin('ozviewer').getMemory( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.param: param 정보
	:param String setting.delimiter: delimiter 정보	
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* 메모리 정보를 Export 처리.


	Example:

	    .. code-block:: javascript
	 
	        var params = "connection.openfile=res://param2.ozd";
	            params += "$$" + "comment.all=true";
	            params += "$$" + "eform.imagepicker_camera_show_choose_button=true";
	            params += "$$" + "eform.inputeventcommand=true";
	            params += "$$" + "eform.signpad_type=zoom";
	            params += "$$" + "eform.show_prev_next_input=true";
	            params += "$$" + "eform.radiobutton_type=dialog";
	            params += "$$" + "eform.checkbox_type=dialog_at_prev_next";
	            params += "$$" + "viewer.useractioncommand=true";

	        M.plugin("ozviewer").getMemory({
	           'param': params,
	           'delimiter' : "$$",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



Document_PingOZServer  
--------------

.. js:function:: M.plugin('ozviewer').ping( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.url: ping 체크를 위한 url 정보
	:param Object setting.option: option 정보 객체
	:param int setting.option.port: port
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* OZ Server 와 ping 점검.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").ping({
	           'url': "192.168.0.12",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });


	    .. code-block:: javascript

	        var option = {};
	        option.port = 8082;
	        M.plugin("ozviewer").ping({
	           'url': "192.168.0.12",
	           'option': option, 
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });




Document_GetGlobal  
--------------

.. js:function:: M.plugin('ozviewer').getGlobal( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.key: 가져올 global 변수의 key 값
	:param Object setting.option: option 정보 객체
	:param int setting.option.docIndex: 페이지 값
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* Global 변수의 정보를 획득.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").getGlobal({
	           'key': "id_03",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });


	    .. code-block:: javascript

	        var option = {};
	        option.docIndex = 2;
	        M.plugin("ozviewer").getGlobal({
	           'key': "id_03",
	           'option': option, 
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



Document_SetGlobal  
--------------

.. js:function:: M.plugin('ozviewer').setGlobal( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.key: 설정 할 global 변수의 key 값
	:param String setting.value: 설정 할 global 변수의 value 값	
	:param Object setting.option: option 정보 객체
	:param int setting.option.docIndex: 페이지 값
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* Global 변수의 정보를 설정.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").setGlobal({
	           'key': "id_03",
	           'value': "이미지 입력",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });


	    .. code-block:: javascript

	        var option = {};
	        option.docIndex = 2;
	        M.plugin("ozviewer").setGlobal({
	           'key': "id_03",
	           'value': "이미지 입력", 
	           'option': option, 
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });




Document_SetChartStyle  
--------------

.. js:function:: M.plugin('ozviewer').setChartStyle( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.style: chart 의 style
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* chart style 설정.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").setChartStyle({
	           'style': "bar",
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });




Document_GetTitle  
--------------

.. js:function:: M.plugin('ozviewer').getTitle( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리결과
		
	* 문서의 타이틀 획득.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").getTitle({
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });


Document_GetPaperWidth  
--------------

.. js:function:: M.plugin('ozviewer').getPaperWidth( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* 문서의 가로 사이즈 정보.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").getPaperWidth({
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });




Document_GetPaperHeight  
--------------

.. js:function:: M.plugin('ozviewer').getPaperHeight( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* 문서의 세로 사이즈 정보.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").getPaperHeight({
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });





Show  
--------------

.. js:function:: M.plugin('ozviewer').show( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* 문서 보이기.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").show({
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });






Hide  
--------------

.. js:function:: M.plugin('ozviewer').hide( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* 문서 감추기.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").show({
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });



close  
--------------

.. js:function:: M.plugin('ozviewer').close( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param Function setting.callback: 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	 :param String status: 상태 ( :ref:`statusType` )
	 :param Object result: 처리 결과
		
	* 문서 종료(제거)하기.


	Example:

	    .. code-block:: javascript
	 
	        M.plugin("ozviewer").close({
	           callback:function(status, result){
	            alert(JSON.stringify(result));
	           }
	        });