ClassMethods with a private keyword tags

Question

Question

Alex Kogan · Jan 11, 2018

My questions are regarding ClassMethods with a private keyword tags.

When we use a wizard to add a new method, we are given a options to
select private checkbox to make it a private method as well as
Class Method checkbox in the same time.

1. What would be the reason and the case to select and use them both?
2. Secondly, if there is such a case in already developed application is it
safe to remove the private tag from ClassMethod? Obviously if it's not a
ClassMethod private tag cannot be removed as easily.

Thank you,

Discussion (11)2

Log in or sign up to continue

Warlin Garcia · Jan 11, 2018

1) The reasons for using both together are purely based on your application's need and design. Some design patterns specify desired visibility of methods for example.

2) Safe depends on the context but it's usually easier to move from a restricted mode to a non-restricted one. Moving methods from private to public shouldn't have any impact on your application (functionality wise). However, the opposite is not true and will require you to modify your code to fix the parts that were accessing previously public methods that are private now. This will also impact clients of your code (API) as they'll face the same challenges with the new restrictions.

1 0

score 0 · Answer 1 · 2018-01-11T13:02:13-05:00

The two concepts are orthogonal. A class method doesn't need an instance; a private method is only visible from within the class. As a contrived example, consider a public hello() class method that calls a private greet() class method.

Is it safe to change a class method from private to public? In the immediate term, sure, but now it's a public part of the class's interface with all the maintenance responsibilities that entails. I don't see how that's obviously any different than an instance method.

score 0 · Answer 2 · 2018-01-11T17:47:13-05:00

They're not orthogonal.

Consider a Person class:

Person
   Method AmISmarterThenTheRest() {
       Set AvgIQ=..GetIQ(..HairColor)
   }

   ClassMethod GetIQ(HairColor) [Private] {
      ; determine the average IQ by HairColor
   }

The GetIQ method is obviously a class method, but you might not want to expose it to the outside world.

There's where one needs (wants) a private class method

score 0 · Answer 3 · 2018-01-11T20:51:25-05:00

Thank you, I think I understand now the differences well, but benefits is still a little odd. Is there a difference / benefit / correct preference between using regular method() [private[ vs classmethod [private]? If for example you are looking to keep your methods private.

score 0 · Answer 4 · 2018-01-11T17:57:48-05:00

That's precisely the intended meaning of orthogonal in this context. All four combinations of public/private and class/instance are distinctly meaningful and useful in their own right. The concepts are separate, independent.

score 0 · Answer 5 · 2018-01-11T18:03:24-05:00

Herman Slagman · Jan 11, 2018

Ah, there's my non-native English: I 'translated' that as 'opposite' in the sense of exclusive, sorry

0 0

score 0 · Answer 6 · 2018-01-11T20:52:07-05:00

I meant - I guess what would be the benefit to use class method [private] vs regular method [private] here?

score 0 · Answer 7 · 2018-01-12T08:11:16-05:00

Private is not important in that case - it only affects from where method could be called. Private methods can be invoked only by methods of this class or its subclasses.

The difference between class methods and instance methods is that instance methods can access object context. For example you can access current object property from instance methods. Use instance methods only when you need access to object context. In all other cases use class methods.

Here's a sample code, highlighting the difference:

Class Test.Person Extends %RegisteredObject {

Property Name As %String;

Method PrintName() {
  Write ..Name
}

ClassMethod PrintText(text) {
  Write text
}

}

score 0 · Answer 8 · 2018-01-11T20:33:20-05:00

Thank you everybody for your answers. My question here would be, why use class method instead of regular method in this case?

If you don't want it to have exposure to outside world, simply make it a regular method within your class, which is going to be private (I believe) by default and use as many as you need privately, while still have an outside entry point if needed with non private class method.

I guess what would be the benefit to use class method vs regular method here?

I see myself small benefit to make something originally class method [private] vs regular method - in case in some point in the future of your application, you need to change the ability to get to the method from the outside and remove the private tag.

score 1 · Answer 9 · 2018-01-12T05:15:58-05:00

Alex, if you code it as an instance method (private or public) then you won't be able to call it from a classmethod (private or public) unless the caller has (or creates) an instance of its class. In other words, the decision about whether to code an instance method or a classmethod is surely independent of the decision about whether to mark that method private or public, no?

score 1 · Answer 10 · 2018-01-12T09:55:11-05:00

Alex, it's all based on your design. The decision of whether a method is an instance or class method is totally independent of whether that method can be private or not. Your design, and patterns or best practices you want to follow, will dictate which way to go. The benefits are in what you want to accomplish with the design: ease of testing, ease of change, etc.