OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

cmis message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: [OASIS Issue Tracker] Commented: (CMIS-497) extension parametersmake code bloated and unreadbable



    [ http://tools.oasis-open.org/issues/browse/CMIS-497?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15299#action_15299 ] 

Jens Huebel commented on CMIS-497:
----------------------------------

There are some more facts worth to mention before making a decision:

The "ugliness-factor" seems to be more an issue of the web service tools than then the API design itself. We have JAX-WS in use here. Now it would be interesting if other tools behave more intelligently and preserve the return value of the method (which is in my opinion the main issue in regards of readability). 

So it would be nice to get more feedback how other tools behave here (Axis, .Net, etc.)

I also missed that the we had a TC decision to introduce this change. See http://tools.oasis-open.org/issues/browse/CMIS-372. So removing extension again is would violate this TC decision. Given the outcome that JAXWS produces after CMIS-372 I now however would  vote for #1 in CMIS-372.

Any idea for improvement is welcome.




> extension parameters make code bloated and unreadbable
> ------------------------------------------------------
>
>                 Key: CMIS-497
>                 URL: http://tools.oasis-open.org/issues/browse/CMIS-497
>             Project: OASIS Content Management Interoperability Services (CMIS) TC
>          Issue Type: Improvement
>          Components: Web Services Binding
>    Affects Versions: Draft 0.62
>            Reporter: Jens Huebel
>            Assignee: Al Brown
>
> With the 0.63 draft all web services get a new extension parameter. This makes API less readable and really ugly.
> Do we really need the flexiibility at this level? Some pseudo code 
> before:
> return _objSvc.getAllowableActions(_repositoryId, id);
> after:
> Holder<CmisAllowableActionsType> holder = new Holder<CmisAllowableActionsType>();
>  _objSvc.getAllowableActions(_repositoryId, id, null, holder);
> return holder.value;
> This requires three lines instead of one. It is no longer clear what the return value is and what parameters have what purpose. We have methods taking three holders, etc. I liked the CMIS API for its clarity and simplicity but now I fear we are far away from this. This seems to affect every function in the web service.
> Do we really need this and want to pay this price? 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]